includes/SocketHandler.h

   1 /**
   2 * Copyright (C) 2011, BMW AG
   3 *
   4 * GeniviAudioMananger AudioManagerDaemon
   5 *
   6 * \file SocketHandler.h
   7 *
   8 * \date 20-Oct-2011 3:42:04 PM
   9 * \author Christian Mueller (christian.ei.mueller@bmw.de)
  10 *
  11 * \section License
  12 * GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
  13 * Copyright (C) 2011, BMW AG Christian Mueller  Christian.ei.mueller@bmw.de
  14 *
  15 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
  16 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License, version 2.1, for more details.
  17 * You should have received a copy of the GNU Lesser General Public License, version 2.1, along with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
  18 * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may also be applicable to programs even in cases in which the program is not a library in the technical sense.
  19 * Linking AudioManager statically or dynamically with other modules is making a combined work based on AudioManager. You may license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to license your linked modules under the GNU Lesser General Public License, version 2.1, you may use the program under the following exception.
  20 * As a special exception, the copyright holders of AudioManager give you permission to combine AudioManager with software programs or libraries that are released under any license unless such a combination is not permitted by the license of such a software program or library. You may copy and distribute such a system following the terms of the GNU Lesser General Public License, version 2.1, including this special exception, for AudioManager and the licenses of the other code concerned.
  21 * Note that people who make modified versions of AudioManager are not obligated to grant this special exception for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, version 2.1, gives permission to release a modified version without this exception; this exception also makes it possible to release a modified version which carries forward this exception.
  22 *
  23 */
  24
  25 #ifndef SOCKETHANDLER_H_
  26 #define SOCKETHANDLER_H_
  27
  28 #include <audiomanagertypes.h>
  29 #include <sys/socket.h>
  30 #include <sys/time.h>
  31 #include <stdint.h>
  32 #include <sys/poll.h>
  33 #include <list>
  34 #include <map>
  35 #include <signal.h>
  36
  37 namespace am {
  38
  39 static volatile sig_atomic_t gDispatchDone = 0;         //this global is used to stop the mainloop
  40
  41 typedef uint16_t sh_timerHandle_t;      //!<this is a handle for a timer to be used with the SocketHandler
  42 typedef uint16_t sh_pollHandle_t;               //!<this is a handle for a filedescriptor to be used with the SocketHandler
  43
  44 class shPollPrepare;
  45 class shPollCheck;
  46 class shPollFired;
  47 class shPollDispatch;
  48 class shTimerCallBack;
  49
  50 class SocketHandler
  51 {
  52 public:
  53         SocketHandler();
  54         virtual ~SocketHandler();
  55
  56         am_Error_e addFDPoll(const int fd,const short event, shPollPrepare *prepare,shPollFired *fired,shPollCheck *check,shPollDispatch *dispatch, void* userData,sh_pollHandle_t& handle);
  57         am_Error_e removeFDPoll(const sh_pollHandle_t handle);
  58         am_Error_e updateEventFlags(const sh_pollHandle_t handle, const short events);
  59         am_Error_e addTimer(const timespec timeouts,shTimerCallBack*& callback,sh_timerHandle_t& handle, void* userData);
  60         am_Error_e removeTimer(const sh_timerHandle_t handle);
  61         am_Error_e restartTimer(const sh_timerHandle_t handle, const timespec timeouts);
  62         am_Error_e stopTimer(const sh_timerHandle_t handle);
  63         void start_listenting();
  64         void stop_listening();
  65 private:
  66         struct timer_s                                          //!<struct that holds information of timers
  67         {
  68                 sh_timerHandle_t handle;                //!<the handle of the timer
  69                 timespec countdown;                             //!<the countdown, this value is decreased every time the timer is up
  70                 timespec timeout;                               //!<the original timer value
  71                 shTimerCallBack* callback;      //!<the callbackfunction
  72                 void * userData;                                //!<saves a void pointer together with the rest.
  73         };
  74
  75         class SubstractTime                                     //!<functor to easy substract from each countdown value
  76         {
  77         private:
  78                 timespec param;
  79         public:
  80                 SubstractTime(timespec param): param(param) {}
  81                 void operator()(timer_s& t) const;
  82         };
  83
  84         struct sh_poll_s                                                //!<struct that holds information about polls
  85         {
  86                 sh_pollHandle_t handle;                         //!<handle to uniquely adress a filedesriptor
  87                 shPollPrepare *prepareCB;
  88                 shPollFired *firedCB;
  89                 shPollCheck *checkCB;
  90                 shPollDispatch *dispatchCB;
  91                 pollfd pollfdValue;                                             //!<the array for polling the filedescriptors
  92                 void *userData;                                         //!<userdata saved together with the callback.
  93         };
  94
  95         typedef std::vector<pollfd> mPollfd_t;          //!<vector of filedescriptors
  96         typedef std::vector<sh_poll_s> mListPoll_t;     //!<list for the callbacks
  97
  98         class CopyPollfd
  99         {
 100         private:
 101                 mPollfd_t& mArray;
 102         public:
 103                 CopyPollfd(mPollfd_t& dest): mArray(dest) {}
 104                 void operator()(const sh_poll_s& row);
 105         };
 106
 107         bool fdIsValid(const int fd) const;
 108         void initTimer();
 109         void timerUp();
 110         int timespec2ms(const timespec& time);
 111         timespec* insertTime(timespec& buffertime);
 112         static bool compareCountdown(const timer_s& a, const timer_s& b)
 113         {
 114                 return (a.countdown.tv_sec==b.countdown.tv_sec) ? (a.countdown.tv_nsec < b.countdown.tv_nsec) : (a.countdown.tv_sec < b.countdown.tv_sec);
 115         }
 116
 117         static bool onlyFiredEvents(const pollfd& a)
 118         {
 119                 return a.revents==0 ? false : true;
 120         }
 121
 122         //todo: maybe we could simplify mListActiveTimer to hold only the handle and the countdown ....
 123         mPollfd_t mfdPollingArray;
 124         mListPoll_t mListPoll;
 125         std::list<timer_s> mListTimer;                  //!<list of all timers
 126         std::list<timer_s> mListActiveTimer;    //!<list of all currently active timers
 127         sh_timerHandle_t mNextTimer;
 128         sh_timerHandle_t mLastInsertedHandle;
 129         sh_pollHandle_t mLastInsertedPollHandle;
 130         timespec mTimeout;
 131         bool mRecreatePollfds;
 132 };
 133
 134 /**
 135  * classic functor for the BasicTimerCallback
 136  */
 137 class shTimerCallBack
 138 {
 139 public:
 140         virtual void Call (const sh_timerHandle_t handle, void* userData)=0;
 141         virtual ~shTimerCallBack(){};
 142 };
 143
 144 class shPollPrepare
 145 {
 146 public:
 147         virtual void Call (const sh_pollHandle_t handle, void* userData)=0;
 148         virtual ~shPollPrepare(){};
 149 };
 150
 151 class shPollFired
 152 {
 153 public:
 154         virtual void Call(const pollfd pollfd,const sh_pollHandle_t handle, void* userData)=0;
 155         virtual ~ shPollFired(){};
 156 };
 157
 158 class shPollCheck
 159 {
 160 public:
 161         virtual bool Call (const sh_pollHandle_t handle, void* userData)=0;
 162         virtual ~ shPollCheck(){};
 163 };
 164
 165 class shPollDispatch
 166 {
 167 public:
 168         virtual bool Call (const sh_pollHandle_t handle, void* userData)=0;
 169         virtual ~ shPollDispatch(){};
 170 };
 171
 172 /**
 173  * template to create the functor for a class
 174  */
 175 template <class TClass> class shTimerCallBack_T : public shTimerCallBack
 176 {
 177 private:
 178         TClass* mInstance;
 179         void (TClass::*mFunction)(sh_timerHandle_t handle, void* userData);
 180
 181 public:
 182         shTimerCallBack_T(TClass* instance, void(TClass::*function)(sh_timerHandle_t handle, void* userData))
 183         :mInstance(instance), mFunction(function){};
 184
 185         virtual void Call(sh_timerHandle_t handle, void* userData)
 186         {
 187                 (*mInstance.*mFunction)(handle, userData);
 188         }
 189 };
 190
 191 /**
 192  * template to create the functor for a class
 193  */
 194 template <class TClass> class shPollPrepare_T : public shPollPrepare
 195 {
 196 private:
 197         TClass* mInstance;
 198         void (TClass::*mFunction)(const sh_timerHandle_t handle, void* userData);
 199
 200 public:
 201         shPollPrepare_T(TClass* instance, void(TClass::*function)(const sh_timerHandle_t handle, void* userData))
 202         :mInstance(instance), mFunction(function){};
 203
 204         virtual void Call(const sh_timerHandle_t handle, void* userData)
 205         {
 206                 (*mInstance.*mFunction)(handle,userData);
 207         };
 208 };
 209
 210 template <class TClass> class shPollFired_T : public shPollFired
 211 {
 212 private:
 213         TClass* mInstance;
 214         void (TClass::*mFunction)(const pollfd pollfd,const sh_pollHandle_t handle, void* userData);
 215
 216 public:
 217         shPollFired_T(TClass* instance, void(TClass::*function)(const pollfd pollfd,const sh_pollHandle_t handle, void* userData))
 218         :mInstance(instance), mFunction(function){};
 219
 220         virtual void Call(const pollfd pollfd,const sh_pollHandle_t handle, void* userData)
 221         {
 222                 (*mInstance.*mFunction)(pollfd,handle,userData);
 223         };
 224 };
 225
 226 template <class TClass> class shPollCheck_T : public shPollCheck
 227 {
 228 private:
 229         TClass* mInstance;
 230         bool (TClass::*mFunction)(const sh_pollHandle_t handle, void* userData);
 231
 232 public:
 233         shPollCheck_T(TClass* instance, bool(TClass::*function)(const sh_pollHandle_t handle, void* userData))
 234         :mInstance(instance), mFunction(function){};
 235
 236         virtual bool Call(const sh_pollHandle_t handle, void* userData)
 237         {
 238                 return (*mInstance.*mFunction)(handle,userData);
 239         };
 240 };
 241
 242 template <class TClass> class shPollDispatch_T : public shPollDispatch
 243 {
 244 private:
 245         TClass* mInstance;
 246         bool (TClass::*mFunction)(const sh_pollHandle_t handle, void* userData);
 247
 248 public:
 249         shPollDispatch_T(TClass* instance, bool (TClass::*function)(const sh_pollHandle_t handle, void* userData))
 250         :mInstance(instance), mFunction(function){};
 251
 252         virtual bool Call(const sh_pollHandle_t handle, void* userData)
 253         {
 254                 return (*mInstance.*mFunction)(handle,userData);
 255         };
 256 };
 257 } /* namespace am */
 258 #endif /* SOCKETHANDLER_H_ */