1 /* Copyright (c) 2015, 2020 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 <loc_pla.h>
35 
36 namespace loc_util {
37 
38 // opaque class to provide service implementation.
39 class LocTimerDelegate;
40 class LocSharedLock;
41 
42 // LocTimer client must extend this class and implementthe callback.
43 // start() / stop() methods are to arm / disarm timer.
44 class LocTimer
45 {
46     LocTimerDelegate* mTimer;
47     LocSharedLock* mLock;
48     // don't really want mLock to be manipulated by clients, yet LocTimer
49     // has to have a reference to the lock so that the delete of LocTimer
50     // and LocTimerDelegate can work together on their share resources.
51     friend class LocTimerDelegate;
52 
53 public:
54     LocTimer();
55     virtual ~LocTimer();
56 
57     // timeOutInMs:  timeout delay in ms
58     // wakeOnExpire: true if to wake up CPU (if sleeping) upon timer
59     //                        expiration and notify the client.
60     //               false if to wait until next time CPU wakes up (if
61     //                        sleeping) and then notify the client.
62     // return:       true on success;
63     //               false on failure, e.g. timer is already running.
64     bool start(uint32_t timeOutInMs, bool wakeOnExpire);
65 
66     // return:       true on success;
67     //               false on failure, e.g. timer is not running.
68     bool stop();
69 
70     //  LocTimer client Should implement this method.
71     //  This method is used for timeout calling back to client. This method
72     //  should be short enough (eg: send a message to your own thread).
73     virtual void timeOutCallback() = 0;
74 };
75 
76 } // namespace loc_util
77 
78 #endif //__LOC_DELAY_H__
79