Home | History | Annotate | Download | only in utils
      1 /* Copyright (c) 2011-2013,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 #ifndef __MSG_TASK__
     30 #define __MSG_TASK__
     31 
     32 #include <LocThread.h>
     33 
     34 struct LocMsg {
     35     inline LocMsg() {}
     36     inline virtual ~LocMsg() {}
     37     virtual void proc() const = 0;
     38     inline virtual void log() const {}
     39 };
     40 
     41 class MsgTask : public LocRunnable {
     42     const void* mQ;
     43     LocThread* mThread;
     44     friend class LocThreadDelegate;
     45 protected:
     46     virtual ~MsgTask();
     47 public:
     48     MsgTask(LocThread::tCreate tCreator, const char* threadName = NULL, bool joinable = true);
     49     MsgTask(const char* threadName = NULL, bool joinable = true);
     50     // this obj will be deleted once thread is deleted
     51     void destroy();
     52     void sendMsg(const LocMsg* msg) const;
     53     // Overrides of LocRunnable methods
     54     // This method will be repeated called until it returns false; or
     55     // until thread is stopped.
     56     virtual bool run();
     57 
     58     // The method to be run before thread loop (conditionally repeatedly)
     59     // calls run()
     60     virtual void prerun();
     61 
     62     // The method to be run after thread loop (conditionally repeatedly)
     63     // calls run()
     64     inline virtual void postrun() {}
     65 };
     66 
     67 #endif //__MSG_TASK__
     68