summaryrefslogtreecommitdiff
path: root/include/command/IAmCommandSend.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/command/IAmCommandSend.h')
-rw-r--r--include/command/IAmCommandSend.h280
1 files changed, 63 insertions, 217 deletions
diff --git a/include/command/IAmCommandSend.h b/include/command/IAmCommandSend.h
index 15577ed..9023bfd 100644
--- a/include/command/IAmCommandSend.h
+++ b/include/command/IAmCommandSend.h
@@ -1,5 +1,5 @@
/**
- * Copyright (C) 2012, BMW AG
+ * Copyright (C) 2012 - 2014, BMW AG
*
* This file is part of GENIVI Project AudioManager.
*
@@ -12,15 +12,16 @@
* this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
+ * \author Christian Linke, christian.linke@bmw.de BMW 2011 - 2014
*
* \file
- * For further information see http://www.genivi.org/.
+ * For further information see http://projects.genivi.org/audio-manager
*
- * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
+ * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL.
+ * PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN.
*/
-#if !defined(EA_37AC20B5_5E6D_4a3f_BA5F_B3F3CBB21C36__INCLUDED_)
-#define EA_37AC20B5_5E6D_4a3f_BA5F_B3F3CBB21C36__INCLUDED_
+#if !defined(EA_68F78255_5C2E_4b32_A21C_E8CEDD4641B3__INCLUDED_)
+#define EA_68F78255_5C2E_4b32_A21C_E8CEDD4641B3__INCLUDED_
#include <vector>
#include <string>
@@ -35,221 +36,66 @@ class IAmCommandReceive;
#define CommandSendVersion "2.0"
namespace am {
- /**
- * This interface handles all communication from the AudioManagerDaemon towards the system. It is designed in such a way
- * that only callbacks with no return types are implemented. So when the CommandInterfacePlugins are designed in such a
- * way that they broadcast signals to any node who is interested in the particular information (like signals on Dbus for
- * example), more information can be retrieved via the CommandReceiveInterface.
- * There are two rules that have to be kept in mind when implementing against this interface:\n
- * \warning
- * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
- * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n
- * \details
- * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-
- * call pattern described on the wiki which also helps to implement calls that are forbidden.\n
- * For more information, please check CAmSerializer
- * @author Christian Mueller
- * @created 17-Jan-2013 10:00:24
- */
- class IAmCommandSend
- {
- public:
- IAmCommandSend() {
+/**
+ * This interface handles all communication from the AudioManagerDaemon towards
+ * the system. It is designed in such a way that only callbacks with no return
+ * types are implemented. So when the CommandInterfacePlugins are designed in such
+ * a way that they broadcast signals to any node who is interested in the
+ * particular information (like signals on Dbus for example), more information can
+ * be retrieved via the CommandReceiveInterface.
+ * There are two rules that have to be kept in mind when implementing against this
+ * interface:\n
+ * \warning
+ * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
+ * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS
+ * CALL THAT EXPECTS A RETURN VALUE.\n
+ * \details
+ * Violation these rules may lead to unexpected behavior! Nevertheless you can
+ * implement thread safe by using the deferred-call pattern described on the wiki
+ * which also helps to implement calls that are forbidden.\n
+ * For more information, please check CAmSerializer
+ */
+class IAmCommandSend
+{
- }
+public:
+ IAmCommandSend() {
- virtual ~IAmCommandSend() {
+ }
- }
+ virtual ~IAmCommandSend() {
- /**
- * returns the interface version as string.
- *
- * @param version
- */
- virtual void getInterfaceVersion(std::string& version) const =0;
- /**
- * This command starts the interface, the plugin itself. This is not meant to start communication with the HMI itself. It
- * is a good idea to implement here everything that sets up the basic communication like DbusCommunication etc...
- * Be aware of side effects with systemd and socketbased communication!
- * @return E_OK on success, E_UNKNOWN on error
- *
- * @param commandreceiveinterface pointer to the receive interface. Is used to call the audiomanagerdaemon
- */
- virtual am_Error_e startupInterface(IAmCommandReceive* commandreceiveinterface) =0;
- /**
- * This function will indirectly be called by the Controller and is used to start the Communication. Before this command,
- * all communication will be ignored by the AudioManager.
- * After the Plugin is ready, it will asynchronously answer with condfirmCommandReady, the handle that is handed over must
- * be returned.
- *
- * @param handle the handle uniquely idenfies the request
- */
- virtual void setCommandReady(const uint16_t handle) =0;
- /**
- * This function will indirectly be called by the Controller and is used to stop the Communication. After this command,
- * all communication will be ignored by the AudioManager. The plugin has to be prepared that either the power will be
- * switched off or the Interface is started again with setCommandReady
- * After the Plugin is ready to rundown, it will asynchronously answer with condfirmCommandRundown, the handle that is
- * handed over must be returned.
- *
- * @param handle This handle uniquly idenfies the request
- */
- virtual void setCommandRundown(const uint16_t handle) =0;
- /**
- * Callback that is called when the number of connections change
- *
- * @param mainConnection
- */
- virtual void cbNewMainConnection(const am_MainConnectionType_s& mainConnection) =0;
- /**
- * Callback that is called when the number of connections change
- *
- * @param mainConnection
- */
- virtual void cbRemovedMainConnection(const am_mainConnectionID_t mainConnection) =0;
- /**
- * Callback that is called when the number of sinks change
- *
- * @param sink
- */
- virtual void cbNewSink(const am_SinkType_s& sink) =0;
- /**
- * Callback that is called when the number of sinks change
- *
- * @param sinkID
- */
- virtual void cbRemovedSink(const am_sinkID_t sinkID) =0;
- /**
- * Callback that is called when the number of sources change
- *
- * @param source
- */
- virtual void cbNewSource(const am_SourceType_s& source) =0;
- /**
- * Callback that is called when the number of sources change
- *
- * @param source
- */
- virtual void cbRemovedSource(const am_sourceID_t source) =0;
- /**
- * this callback is fired if the number of sink classes changed
- */
- virtual void cbNumberOfSinkClassesChanged() =0;
- /**
- * this callback is fired if the number of source classes changed
- */
- virtual void cbNumberOfSourceClassesChanged() =0;
- /**
- * This callback is called when the ConnectionState of a connection changed.
- *
- * @param connectionID
- * @param connectionState
- */
- virtual void cbMainConnectionStateChanged(const am_mainConnectionID_t connectionID, const am_ConnectionState_e connectionState) =0;
- /**
- * this callback indicates that a sinkSoundProperty has changed.
- *
- * @param sinkID
- * @param soundProperty
- */
- virtual void cbMainSinkSoundPropertyChanged(const am_sinkID_t sinkID, const am_MainSoundProperty_s& soundProperty) =0;
- /**
- * this callback indicates that a sourceSoundProperty has changed.
- *
- * @param sourceID
- * @param soundProperty
- */
- virtual void cbMainSourceSoundPropertyChanged(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty) =0;
- /**
- * this callback is called when the availability of a sink has changed
- *
- * @param sinkID
- * @param availability
- */
- virtual void cbSinkAvailabilityChanged(const am_sinkID_t sinkID, const am_Availability_s& availability) =0;
- /**
- * this callback is called when the availability of source has changed.
- *
- * @param sourceID
- * @param availability
- */
- virtual void cbSourceAvailabilityChanged(const am_sourceID_t sourceID, const am_Availability_s& availability) =0;
- /**
- * this callback indicates a volume change on the indicated sink
- *
- * @param sinkID
- * @param volume
- */
- virtual void cbVolumeChanged(const am_sinkID_t sinkID, const am_mainVolume_t volume) =0;
- /**
- * this callback indicates a mute state change on a sink.
- *
- * @param sinkID
- * @param muteState
- */
- virtual void cbSinkMuteStateChanged(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0;
- /**
- * is fired if a systemProperty changed
- *
- * @param systemProperty
- */
- virtual void cbSystemPropertyChanged(const am_SystemProperty_s& systemProperty) =0;
- /**
- * This callback is fired if the timinginformation for a mainConnectionID changed
- *
- * @param mainConnectionID
- * @param time
- */
- virtual void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time) =0;
- /**
- * This callback is called when a sink is updated.
- *
- * @param sinkID The sinkID that is updated
- * @param sinkClassID The sinkClassID of the updated sink. gives the current value even if not updated
- * @param listMainSoundProperties The list of mainSoundProperties. Gives the actual list of MainSoundProperties even if
- * not changed
- */
- virtual void cbSinkUpdated(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0;
- /**
- * This callback is called when a source is updated.
- *
- * @param sourceID The sourceID that is updated
- * @param sourceClassID The sourceClassID of the updated source. Gives the current value even if not updated
- * @param listMainSoundProperties The list of mainSoundProperties. Gives the actual list of MainSoundProperties even if
- * not changed
- */
- virtual void cbSourceUpdated(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0;
- /**
- * This callback is called when a notificated value of a sink changes.
- *
- * @param sinkID The sinkID
- * @param notification The payload of the notification
- */
- virtual void cbSinkNotification(const am_sinkID_t sinkID, const am_NotificationPayload_s& notification) =0;
- /**
- * This callback is called when a notifcated value of a source changes.
- *
- * @param sourceID The sourceID
- * @param notification The payload of the notification
- */
- virtual void cbSourceNotification(const am_sourceID_t sourceID, const am_NotificationPayload_s& notification) =0;
- /**
- * This callback is triggered when a mainNotificationConfiguration is changed.
- *
- * @param sinkID
- * @param mainNotificationConfiguration The MainNotificationConfiguration that changed
- */
- virtual void cbMainSinkNotificationConfigurationChanged(const am_sinkID_t sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration) =0;
- /**
- * This callback is triggered when a mainNotificationConfiguration is changed.
- *
- * @param sourceID
- * @param mainNotificationConfiguration The MainNotificationConfiguration that changed
- */
- virtual void cbMainSourceNotificationConfigurationChanged(const am_sourceID_t sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration) =0;
+ }
- };
+ virtual void getInterfaceVersion(std::string& version) const =0;
+ virtual am_Error_e startupInterface(IAmCommandReceive* commandreceiveinterface) =0;
+ virtual void setCommandReady(const uint16_t handle) =0;
+ virtual void setCommandRundown(const uint16_t handle) =0;
+ virtual void cbNewMainConnection(const am_MainConnectionType_s& mainConnection) =0;
+ virtual void cbRemovedMainConnection(const am_mainConnectionID_t mainConnection) =0;
+ virtual void cbNewSink(const am_SinkType_s& sink) =0;
+ virtual void cbRemovedSink(const am_sinkID_t sinkID) =0;
+ virtual void cbNewSource(const am_SourceType_s& source) =0;
+ virtual void cbRemovedSource(const am_sourceID_t source) =0;
+ virtual void cbNumberOfSinkClassesChanged() =0;
+ virtual void cbNumberOfSourceClassesChanged() =0;
+ virtual void cbMainConnectionStateChanged(const am_mainConnectionID_t connectionID, const am_ConnectionState_e connectionState) =0;
+ virtual void cbMainSinkSoundPropertyChanged(const am_sinkID_t sinkID, const am_MainSoundProperty_s& soundProperty) =0;
+ virtual void cbMainSourceSoundPropertyChanged(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty) =0;
+ virtual void cbSinkAvailabilityChanged(const am_sinkID_t sinkID, const am_Availability_s& availability) =0;
+ virtual void cbSourceAvailabilityChanged(const am_sourceID_t sourceID, const am_Availability_s& availability) =0;
+ virtual void cbVolumeChanged(const am_sinkID_t sinkID, const am_mainVolume_t volume) =0;
+ virtual void cbSinkMuteStateChanged(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0;
+ virtual void cbSystemPropertyChanged(const am_SystemProperty_s& systemProperty) =0;
+ virtual void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time) =0;
+ virtual void cbSinkUpdated(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0;
+ virtual void cbSourceUpdated(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0;
+ virtual void cbSinkNotification(const am_sinkID_t sinkID, const am_NotificationPayload_s& notification) =0;
+ virtual void cbSourceNotification(const am_sourceID_t sourceID, const am_NotificationPayload_s& notification) =0;
+ virtual void cbMainSinkNotificationConfigurationChanged(const am_sinkID_t sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration) =0;
+ virtual void cbMainSourceNotificationConfigurationChanged(const am_sourceID_t sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration) =0;
+
+};
}
-#endif // !defined(EA_37AC20B5_5E6D_4a3f_BA5F_B3F3CBB21C36__INCLUDED_)
+#endif // !defined(EA_68F78255_5C2E_4b32_A21C_E8CEDD4641B3__INCLUDED_)
View Lorry Controller Status