summaryrefslogtreecommitdiff
path: root/includes/command/CommandSendInterface.h
diff options
context:
space:
mode:
Diffstat (limited to 'includes/command/CommandSendInterface.h')
-rw-r--r--includes/command/CommandSendInterface.h21
1 files changed, 12 insertions, 9 deletions
diff --git a/includes/command/CommandSendInterface.h b/includes/command/CommandSendInterface.h
index bd970d0..f8c47be 100644
--- a/includes/command/CommandSendInterface.h
+++ b/includes/command/CommandSendInterface.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_1EBB5273_A222_43b8_B7C9_435405DF9AA2__INCLUDED_)
-#define EA_1EBB5273_A222_43b8_B7C9_435405DF9AA2__INCLUDED_
+#if !defined(EA_A230EB7E_1719_4470_BCC6_12B0606A80E6__INCLUDED_)
+#define EA_A230EB7E_1719_4470_BCC6_12B0606A80E6__INCLUDED_
#include <vector>
#include <string>
@@ -35,13 +35,16 @@ class CommandReceiveInterface;
#include "CommandReceiveInterface.h"
-#define CommandSendVersion 1
+#define CommandSendVersion 1.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.
- * @author christian
- * @version 1.0
- * @created 10-Feb-2012 1:31:05 PM
+ * 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:
+ * 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:36 PM
*/
class CommandSendInterface
{
@@ -165,4 +168,4 @@ namespace am {
};
}
-#endif // !defined(EA_1EBB5273_A222_43b8_B7C9_435405DF9AA2__INCLUDED_)
+#endif // !defined(EA_A230EB7E_1719_4470_BCC6_12B0606A80E6__INCLUDED_)