2 * Copyright (C) 2011, BMW AG
4 * GeniviAudioMananger AudioManagerDaemon
6 * \file SocketHandler.h
8 * \date 20-Oct-2011 3:42:04 PM
9 * \author Christian Mueller (christian.ei.mueller@bmw.de)
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
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.
25 #ifndef SOCKETHANDLER_H_
26 #define SOCKETHANDLER_H_
28 #include <audiomanagertypes.h>
29 #include <sys/socket.h>
38 typedef uint16_t sh_timerHandle_t; //!<this is a handle for a timer to be used with the SocketHandler
39 typedef uint16_t sh_pollHandle_t; //!<this is a handle for a filedescriptor to be used with the SocketHandler
45 class shTimerCallBack;
51 virtual ~SocketHandler();
53 am_Error_e addFDPoll(const int fd,const short event, shPollPrepare *prepare,shPollFired *fired,shPollCheck *check,shPollDispatch *dispatch, void* userData,sh_pollHandle_t& handle);
54 am_Error_e removeFDPoll(const sh_pollHandle_t handle);
55 am_Error_e updateEventFlags(const sh_pollHandle_t handle, const short events);
56 am_Error_e addTimer(const timespec timeouts,shTimerCallBack*& callback,sh_timerHandle_t& handle, void* userData);
57 am_Error_e removeTimer(const sh_timerHandle_t handle);
58 am_Error_e restartTimer(const sh_timerHandle_t handle, const timespec timeouts);
59 am_Error_e stopTimer(const sh_timerHandle_t handle);
60 void start_listenting();
61 void stop_listening();
64 struct timer_s //!<struct that holds information of timers
66 sh_timerHandle_t handle; //!<the handle of the timer
67 timespec countdown; //!<the countdown, this value is decreased every time the timer is up
68 timespec timeout; //!<the original timer value
69 shTimerCallBack* callback; //!<the callbackfunction
70 void * userData; //!<saves a void pointer together with the rest.
73 class SubstractTime //!<functor to easy substract from each countdown value
78 SubstractTime(timespec param): param(param) {}
79 void operator()(timer_s& t) const;
82 struct sh_poll_s //!<struct that holds information about polls
84 sh_pollHandle_t handle; //!<handle to uniquely adress a filedesriptor
85 shPollPrepare *prepareCB;
88 shPollDispatch *dispatchCB;
89 pollfd pollfdValue; //!<the array for polling the filedescriptors
90 void *userData; //!<userdata saved together with the callback.
93 typedef std::vector<pollfd> mPollfd_t; //!<vector of filedescriptors
94 typedef std::vector<sh_poll_s> mListPoll_t; //!<list for the callbacks
101 CopyPollfd(mPollfd_t& dest): mArray(dest) {}
102 void operator()(const sh_poll_s& row);
105 bool fdIsValid(const int fd) const;
108 int timespec2ms(const timespec& time);
109 static bool compareCountdown(const timer_s& a, const timer_s& b)
111 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);
114 static bool onlyFiredEvents(const pollfd& a)
116 return a.events==0 ? false : true;
119 //todo: maybe we could simplify mListActiveTimer to hold only the handle and the countdown ....
120 mPollfd_t mfdPollingArray;
121 mListPoll_t mListPoll;
122 std::list<timer_s> mListTimer; //!<list of all timers
123 std::list<timer_s> mListActiveTimer; //!<list of all currently active timers
124 sh_timerHandle_t mNextTimer;
125 sh_timerHandle_t mLastInsertedHandle;
126 sh_pollHandle_t mLastInsertedPollHandle;
129 bool mRecreatePollfds;
133 * classic functor for the BasicTimerCallback
135 class shTimerCallBack
138 virtual void Call (const sh_timerHandle_t handle, void* userData)=0;
139 virtual ~shTimerCallBack(){};
145 virtual void Call (const sh_pollHandle_t handle, void* userData)=0;
146 virtual ~shPollPrepare(){};
152 virtual void Call(const pollfd pollfd,const sh_pollHandle_t handle, void* userData)=0;
153 virtual ~ shPollFired(){};
159 virtual bool Call (const sh_pollHandle_t handle, void* userData)=0;
160 virtual ~ shPollCheck(){};
166 virtual bool Call (const sh_pollHandle_t handle, void* userData)=0;
167 virtual ~ shPollDispatch(){};
171 * template to create the functor for a class
173 template <class TClass> class shTimerCallBack_T : public shTimerCallBack
177 void (TClass::*mFunction)(sh_timerHandle_t handle, void* userData);
180 shTimerCallBack_T(TClass* instance, void(TClass::*function)(sh_timerHandle_t handle, void* userData))
181 :mInstance(instance), mFunction(function){};
183 virtual void Call(sh_timerHandle_t handle, void* userData)
185 (*mInstance.*mFunction)(handle, userData);
190 * template to create the functor for a class
192 template <class TClass> class shPollPrepare_T : public shPollPrepare
196 void (TClass::*mFunction)(const sh_timerHandle_t handle, void* userData);
199 shPollPrepare_T(TClass* instance, void(TClass::*function)(const sh_timerHandle_t handle, void* userData))
200 :mInstance(instance), mFunction(function){};
202 virtual void Call(const sh_timerHandle_t handle, void* userData)
204 (*mInstance.*mFunction)(handle,userData);
208 template <class TClass> class shPollFired_T : public shPollFired
212 void (TClass::*mFunction)(const pollfd pollfd,const sh_pollHandle_t handle, void* userData);
215 shPollFired_T(TClass* instance, void(TClass::*function)(const pollfd pollfd,const sh_pollHandle_t handle, void* userData))
216 :mInstance(instance), mFunction(function){};
218 virtual void Call(const pollfd pollfd,const sh_pollHandle_t handle, void* userData)
220 (*mInstance.*mFunction)(pollfd,handle,userData);
224 template <class TClass> class shPollCheck_T : public shPollCheck
228 bool (TClass::*mFunction)(const sh_pollHandle_t handle, void* userData);
231 shPollCheck_T(TClass* instance, bool(TClass::*function)(const sh_pollHandle_t handle, void* userData))
232 :mInstance(instance), mFunction(function){};
234 virtual bool Call(const sh_pollHandle_t handle, void* userData)
236 return (*mInstance.*mFunction)(handle,userData);
240 template <class TClass> class shPollDispatch_T : public shPollDispatch
244 bool (TClass::*mFunction)(const sh_pollHandle_t handle, void* userData);
247 shPollDispatch_T(TClass* instance, bool (TClass::*function)(const sh_pollHandle_t handle, void* userData))
248 :mInstance(instance), mFunction(function){};
250 virtual bool Call(const sh_pollHandle_t handle, void* userData)
252 return (*mInstance.*mFunction)(handle,userData);
256 #endif /* SOCKETHANDLER_H_ */