includes/dbus/DBusWrapper.h

   1 /**
   2  * Copyright (C) 2011, BMW AG
   3  *
   4  * GeniviAudioMananger AudioManagerDaemon
   5  *
   6  * \file DBusWrapper.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  * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
  24  */
  25
  26 #ifndef DBUSWRAPPER_H_
  27 #define DBUSWRAPPER_H_
  28
  29 #include <config.h>
  30 #include <SocketHandler.h>
  31 #include <dbus/dbus.h>
  32 #include <string>
  33 #include <list>
  34
  35 namespace am
  36 {
  37 /**
  38  * This wraps dbus and provides everything needed to anyone who wants to use dbus (including plugins)
  39  */
  40 class DBusWrapper
  41 {
  42 public:
  43     DBusWrapper(SocketHandler* socketHandler);
  44     virtual ~DBusWrapper();
  45
  46     /**
  47      * registers a callback that is entered as path below the main path.
  48      * The configuration of the mainpath is done via DBusConfiguration.h
  49      * @param vtable the vtable that holds a pointer to the callback that is called when the path is called from the dbus
  50      * @param path the name of the path
  51      * @param userdata pointer to the class that will handle the callback
  52      */
  53     void registerCallback(const DBusObjectPathVTable* vtable, const std::string& path, void* userdata);
  54
  55     /**
  56      * returns the dbus connection
  57      * @param connection pointer to the connection
  58      */
  59     void getDBusConnection(DBusConnection*& connection) const;
  60
  61     static dbus_bool_t addWatch(DBusWatch *watch, void *userData);
  62     static void removeWatch(DBusWatch *watch, void *userData);
  63     static void toogleWatch(DBusWatch *watch, void *userData);
  64
  65     static dbus_bool_t addTimeout(DBusTimeout *timeout, void* userData);
  66     static void removeTimeout(DBusTimeout *timeout, void* userData);
  67     static void toggleTimeout(DBusTimeout *timeout, void* userData);
  68
  69     bool dbusDispatchCallback(const sh_pollHandle_t handle, void* userData);
  70     shPollDispatch_T<DBusWrapper> pDbusDispatchCallback;
  71
  72     void dbusFireCallback(const pollfd pollfd, const sh_pollHandle_t handle, void* userData);
  73     shPollFired_T<DBusWrapper> pDbusFireCallback;
  74
  75     bool dbusCheckCallback(const sh_pollHandle_t handle, void* userData);
  76     shPollCheck_T<DBusWrapper> pDbusCheckCallback;
  77
  78     void dbusTimerCallback(sh_timerHandle_t handle, void* userData);
  79     shTimerCallBack_T<DBusWrapper> pDbusTimerCallback;
  80
  81 private:
  82     static DBusWrapper* mReference;
  83     static DBusHandlerResult cbRootIntrospection(DBusConnection *conn, DBusMessage *msg, void *reference);
  84     dbus_bool_t addWatchDelegate(DBusWatch * watch, void* userData);
  85     void removeWatchDelegate(DBusWatch *watch, void *userData);
  86     void toogleWatchDelegate(DBusWatch *watch, void *userData);
  87     dbus_bool_t addTimeoutDelegate(DBusTimeout *timeout, void* userData);
  88     void removeTimeoutDelegate(DBusTimeout *timeout, void* userData);
  89     void toggleTimeoutDelegate(DBusTimeout *timeout, void* userData);
  90     DBusObjectPathVTable mObjectPathVTable;
  91     DBusConnection* mDbusConnection;
  92     DBusError mDBusError;
  93     std::list<std::string> mNodesList;
  94     std::vector<sh_timerHandle_t*> mListTimerhandlePointer;
  95     SocketHandler *mSocketHandler;
  96     std::map<DBusWatch*, sh_pollHandle_t> mMapHandleWatch;
  97 };
  98
  99 }
 100
 101 #endif /* DBUSWRAPPER_H_ */