PluginCommandInterfaceDbus/include/DBusMessageHandler.h

   1 /**
   2 * Copyright (C) 2011, BMW AG
   3 *
   4 * GeniviAudioMananger DbusPlugin
   5 *
   6 * \file DBusMessageHandler
   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 _DBUSMESSAGEHANDLER_H_
  27 #define _DBUSMESSAGEHANDLER_H_
  28
  29
  30 #include <audiomanagertypes.h>
  31 #include <dbus/dbus.h>
  32 #include <dlt/dlt.h>
  33 #include <vector>
  34 #include <sstream>
  35 #include <string>
  36 #include <list>
  37
  38 namespace am {
  39
  40
  41 /**
  42  * handles DBus Messages, is used to extract & append parameters and send messages
  43  */
  44 class DBusMessageHandler
  45 {
  46 public:
  47         DBusMessageHandler();
  48     ~DBusMessageHandler();
  49
  50     /**
  51      * sets the DBus Connection
  52      * @param connection pointer to the DBus Connection
  53      */
  54     void setDBusConnection(DBusConnection*& connection);
  55
  56     /**
  57      * is called to initiate the receiving of a message
  58      * @param msg pointer to the message to be received
  59      */
  60     void initReceive(DBusMessage* msg);
  61
  62     /**
  63      *  is called to initiate the reply to a message
  64      * @param msg pointer to the message the reply is for
  65      */
  66     void initReply(DBusMessage* msg);
  67
  68     /**
  69      * inits a signal to be sent via dbus
  70      * parameters can be added before sending the signal
  71      * @param path the path
  72      * @param signalName the signal name
  73      */
  74     void initSignal(std::string path, std::string signalName);
  75
  76     /**
  77      * sends out the message
  78      */
  79     void sendMessage();
  80
  81     /**
  82      * the get functions return a value from the received dbus message
  83      * @return
  84      */
  85     dbus_uint16_t getUInt();
  86     dbus_int16_t getInt();
  87     dbus_bool_t getBool();
  88     char getByte();
  89     double getDouble();
  90     char* getString();
  91     void getProperty(dbus_int16_t& type, dbus_int16_t& value);
  92
  93     /**
  94      * the overloaded append function appends different datatypes to the dbusmessage
  95      */
  96     void append(dbus_int16_t toAppend);
  97     void append(dbus_uint16_t toAppend);
  98     void append(char toAppend);
  99     void append(bool toAppend);
 100     void append(double toAppend);
 101     void append(const am::am_SinkType_s& sinkType);
 102     void append(const am::am_SourceType_s& sourceType);
 103     void append(const am::am_MainSoundProperty_s mainSoundProperty);
 104     void append(const am::am_Availability_s & availability);
 105     void append(const am::am_SystemProperty_s & SystemProperty);
 106     void append(const std::vector<am::am_MainConnectionType_s>& listMainConnections);
 107     void append(const std::vector<am::am_SinkType_s>& listMainSinks);
 108     void append(const std::vector<am::am_SourceType_s>& listMainSources);
 109     void append(const std::vector<am::am_MainSoundProperty_s>& listMainSoundProperties);
 110     void append(const std::vector<am::am_SourceClass_s>& listSourceClasses);
 111     void append(const std::vector<am::am_SinkClass_s>& listSinkClasses);
 112     void append(const std::vector<am::am_SystemProperty_s>& listSystemProperties);
 113
 114 private:
 115
 116     DBusMessageIter mDBusMessageIter;
 117     DBusError mDBusError;
 118     dbus_uint32_t mSerial;
 119     std::string mErrorName;
 120     std::string mErrorMsg;
 121     DBusMessage* mDbusMessage;
 122     DBusMessage* mReveiveMessage;
 123     DBusConnection* mDBusConnection;
 124 };
 125
 126 }
 127
 128 #endif // _DBUSMESSAGEWRAPPER_H_