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