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