diff options
Diffstat (limited to 'include/command/IAmCommandSend.h')
| -rw-r--r-- | include/command/IAmCommandSend.h | 106 |
1 files changed, 72 insertions, 34 deletions
diff --git a/include/command/IAmCommandSend.h b/include/command/IAmCommandSend.h index bf073f9..ce32131 100644 --- a/include/command/IAmCommandSend.h +++ b/include/command/IAmCommandSend.h @@ -12,15 +12,15 @@ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
*
* \file
* For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_)
-#define EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_
+#if !defined(EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_)
+#define EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_
#include <vector>
#include <string>
@@ -31,29 +31,25 @@ class IAmCommandReceive; } #include "IAmCommandReceive.h" +#include "audiomanagertypes.h" -#define CommandSendVersion "1.0" +#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 + * 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 + * 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 + * 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 07-Mar-2012 6:06:17 PM + * @created 16-Dez-2012 15:58:14 */ class IAmCommandSend { @@ -74,33 +70,29 @@ namespace am { */ 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... + * 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 + * @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. + * 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 + * 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. + * 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 */ @@ -211,7 +203,53 @@ namespace am { * @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 notifcated 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 cbSinkMainNotificationConfigurationChanged(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 cbSourceMainNotificationConfigurationChanged(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0; }; } -#endif // !defined(EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_) +#endif // !defined(EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_) |