Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHenrik Rentz-Reichert2013-12-03 10:58:46 -0500
committerHenrik Rentz-Reichert2013-12-04 09:43:46 -0500
commit14009fe85a0e9a4e4b26cd4da4410097b93b3aa7 (patch)
tree71dc85f2587b3695a5953e6277e9fb665303a4ff /runtime/org.eclipse.etrice.runtime.c/src/common/messaging/etMessageReceiver.h
parent8c8074b44e71bd77bbf521e444e42595c65e7120 (diff)
downloadorg.eclipse.etrice-14009fe85a0e9a4e4b26cd4da4410097b93b3aa7.tar.gz
org.eclipse.etrice-14009fe85a0e9a4e4b26cd4da4410097b93b3aa7.tar.xz
org.eclipse.etrice-14009fe85a0e9a4e4b26cd4da4410097b93b3aa7.zip
406871: [runtime.c] finish doxygen documentation for runtime.c
https://bugs.eclipse.org/bugs/show_bug.cgi?id=406871 Change-Id: I2973b87bebc726a7aafa89d7b181bf7f16059834
Diffstat (limited to 'runtime/org.eclipse.etrice.runtime.c/src/common/messaging/etMessageReceiver.h')
-rw-r--r--runtime/org.eclipse.etrice.runtime.c/src/common/messaging/etMessageReceiver.h27
1 files changed, 26 insertions, 1 deletions
diff --git a/runtime/org.eclipse.etrice.runtime.c/src/common/messaging/etMessageReceiver.h b/runtime/org.eclipse.etrice.runtime.c/src/common/messaging/etMessageReceiver.h
index 06cd7df78..566c94707 100644
--- a/runtime/org.eclipse.etrice.runtime.c/src/common/messaging/etMessageReceiver.h
+++ b/runtime/org.eclipse.etrice.runtime.c/src/common/messaging/etMessageReceiver.h
@@ -10,15 +10,40 @@
*
*******************************************************************************/
-
+/**
+ * \file etMessageReceiver.h
+ *
+ * method prototypes used by the messaging
+ *
+ * \author Thomas Schuetz
+ */
#ifndef _ETMESSAGERECEIVER_H_
#define _ETMESSAGERECEIVER_H_
#include "messaging/etMessage.h"
+/**
+ * method prototype that receives a message
+ *
+ * \param self the this pointer
+ * \param ifitem a pointer to the interface item that received the message
+ * \param msg the message
+ */
typedef void (*etActorReceiveMessage)(void* self, const void* ifitem, const etMessage* msg);
+
+/**
+ * method prototype for a dispatcher method
+ *
+ * \param msg the message
+ *
+ * \return <code>true</code> if the message could be delivered
+ */
typedef etBool (*etDispatcherReceiveMessage)(const etMessage* msg);
+
+/**
+ * prototype for the periodic call to the <code>execute()</code> method of the dispatcher
+ */
typedef void (*etDispatcherExecute)(void);
#endif /* _ETMESSAGERECEIVER_H_ */

Back to the top