1/* Copyright (c) 2015, The Linux Foundation. All rights reserved.
2 *
3 * Redistribution and use in source and binary forms, with or without
4 * modification, are permitted provided that the following conditions are
5 * met:
6 *     * Redistributions of source code must retain the above copyright
7 *       notice, this list of conditions and the following disclaimer.
8 *     * Redistributions in binary form must reproduce the above
9 *       copyright notice, this list of conditions and the following
10 *       disclaimer in the documentation and/or other materials provided
11 *       with the distribution.
12 *     * Neither the name of The Linux Foundation, nor the names of its
13 *       contributors may be used to endorse or promote products derived
14 *       from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
26 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 */
29
30#ifndef __LOC_TIMER_CPP_H__
31#define __LOC_TIMER_CPP_H__
32
33#include <stddef.h>
34#include <log_util.h>
35
36// opaque class to provide service implementation.
37class LocTimerDelegate;
38class LocSharedLock;
39
40// LocTimer client must extend this class and implementthe callback.
41// start() / stop() methods are to arm / disarm timer.
42class LocTimer
43{
44    LocTimerDelegate* mTimer;
45    LocSharedLock* mLock;
46    // don't really want mLock to be manipulated by clients, yet LocTimer
47    // has to have a reference to the lock so that the delete of LocTimer
48    // and LocTimerDelegate can work together on their share resources.
49    friend class LocTimerDelegate;
50
51public:
52    LocTimer();
53    virtual ~LocTimer();
54
55    // timeOutInMs:  timeout delay in ms
56    // wakeOnExpire: true if to wake up CPU (if sleeping) upon timer
57    //                        expiration and notify the client.
58    //               false if to wait until next time CPU wakes up (if
59    //                        sleeping) and then notify the client.
60    // return:       true on success;
61    //               false on failure, e.g. timer is already running.
62    bool start(uint32_t timeOutInMs, bool wakeOnExpire);
63
64    // return:       true on success;
65    //               false on failure, e.g. timer is not running.
66    bool stop();
67
68    //  LocTimer client Should implement this method.
69    //  This method is used for timeout calling back to client. This method
70    //  should be short enough (eg: send a message to your own thread).
71    virtual void timeOutCallback() = 0;
72};
73
74#endif //__LOC_DELAY_H__
75