diff options
author | christian mueller <christian.ei.mueller@bmw.de> | 2012-02-21 18:21:51 +0100 |
---|---|---|
committer | christian mueller <christian.ei.mueller@bmw.de> | 2012-02-21 18:21:51 +0100 |
commit | 817b5ead32bb080bd5a6fff26b3957d400ba598c (patch) | |
tree | 8a9ee999711a1fc2300b086d2acab558da6fded9 /includes/control/ControlSendInterface.h | |
parent | e2773d0816b538c241d63054e2850e215ac96f97 (diff) | |
download | audiomanager-817b5ead32bb080bd5a6fff26b3957d400ba598c.tar.gz |
* [ GAM-18 ] Add cancel rundown messages to interfaces: added possbility for controller to call rundown on command and routing interfaces
* beautified EA generated code in comments
Diffstat (limited to 'includes/control/ControlSendInterface.h')
-rw-r--r-- | includes/control/ControlSendInterface.h | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/includes/control/ControlSendInterface.h b/includes/control/ControlSendInterface.h index 2d49593..79aeb71 100644 --- a/includes/control/ControlSendInterface.h +++ b/includes/control/ControlSendInterface.h @@ -10,7 +10,7 @@ *
* \section License
* GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
-* Copyright (C) 2011, BMW AG Christian M?ller Christian.ei.mueller@bmw.de
+* Copyright (C) 2011, BMW AG Christian Mueller Christian.ei.mueller@bmw.de
*
* 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.
* 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.
@@ -22,8 +22,8 @@ *
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_F931365D_53A0_4830_8B3E_29C95C767ADC__INCLUDED_)
-#define EA_F931365D_53A0_4830_8B3E_29C95C767ADC__INCLUDED_
+#if !defined(EA_71CB967F_6C92_467f_99BE_B9F5210165C2__INCLUDED_)
+#define EA_71CB967F_6C92_467f_99BE_B9F5210165C2__INCLUDED_
#include <vector>
#include <string>
@@ -33,14 +33,17 @@ namespace am { class ControlReceiveInterface;
} -#define ControlSendVersion 1 +#define ControlSendVersion 1.0 namespace am { /** * This interface is presented by the AudioManager controller.
- * All the hooks represent system events that need to be handled. The callback functions are used to handle for example answers to function calls on the AudioManagerCoreInterface. - * @author christian - * @version 1.0 - * @created 10-Feb-2012 1:31:06 PM + * All the hooks represent system events that need to be handled. The callback functions are used to handle for example answers to function calls on the AudioManagerCoreInterface.
+ * There are two rules that have to be kept in mind when implementing against this interface:
+ * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!!
+ * 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.
+ * 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. + * @author Christian Mueller + * @created 21-Feb-2012 4:58:37 PM */ class ControlSendInterface { @@ -355,10 +358,11 @@ namespace am { * * @param sourceID sourceID of source that shall be connected * @param sinkID sinkID of sink that shall be connected + * @param listRoute This route is the one the priorized connectionFormats is for. * @param listPossibleConnectionFormats list of possible connectionformats * @param listPrioConnectionFormats the list return with prioos from the controller. Best choice on first position. */ - virtual am_Error_e getConnectionFormatChoice(const am_sourceID_t sourceID, const am_sinkID_t sinkID, const std::vector<am_ConnectionFormat_e> listPossibleConnectionFormats, std::vector<am_ConnectionFormat_e>& listPrioConnectionFormats) =0; + virtual am_Error_e getConnectionFormatChoice(const am_sourceID_t sourceID, const am_sinkID_t sinkID, const am_Route_s listRoute, const std::vector<am_ConnectionFormat_e> listPossibleConnectionFormats, std::vector<am_ConnectionFormat_e>& listPrioConnectionFormats) =0; /** * This function returns the version of the interface
* returns E_OK, E_UNKOWN if version is unknown. @@ -367,4 +371,4 @@ namespace am { }; } -#endif // !defined(EA_F931365D_53A0_4830_8B3E_29C95C767ADC__INCLUDED_) +#endif // !defined(EA_71CB967F_6C92_467f_99BE_B9F5210165C2__INCLUDED_) |