X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/193edb1b7e0828fb6c6daa5dfac260468bb41e96..2e81aeec4dfd8d6d5cf1f017f407059ca6a4e1f3:/include/msg/datatypes.h
diff --git a/include/msg/datatypes.h b/include/msg/datatypes.h
index 9a49c4a2cc..3187380740 100644
--- a/include/msg/datatypes.h
+++ b/include/msg/datatypes.h
@@ -9,19 +9,19 @@
#define MSG_DATATYPE_H
#include "xbt/misc.h"
-BEGIN_DECL()
+SG_BEGIN_DECL()
/* ******************************** Host ************************************ */
-/** @defgroup m_datatypes_management_details */
-
-typedef struct simdata_host *simdata_host_t;
+/** @defgroup m_datatypes_management_details Details on MSG datatypes
+ @ingroup m_datatypes_management*/
+ typedef struct simdata_host *simdata_host_t;
/** @brief Host datatype
@ingroup m_datatypes_management_details */
-typedef struct m_host {
- char *name; /**< @brief host name if any */
- simdata_host_t simdata; /**< @brief simulator data */
- void *data; /**< @brief user data */
-} s_m_host_t;
+ typedef struct m_host {
+ char *name; /**< @brief host name if any */
+ simdata_host_t simdata; /**< @brief simulator data */
+ void *data; /**< @brief user data */
+ } s_m_host_t;
/** @brief Host datatype
@ingroup m_datatypes_management
@@ -34,18 +34,18 @@ typedef struct m_host {
\see m_host_management
@{ */
-typedef struct m_host *m_host_t;
+ typedef struct m_host *m_host_t;
/** @} */
/* ******************************** Task ************************************ */
-typedef struct simdata_task *simdata_task_t;
+ typedef struct simdata_task *simdata_task_t;
/** @brief Task datatype
@ingroup m_datatypes_management_details */
-typedef struct m_task {
- char *name; /**< @brief task name if any */
- simdata_task_t simdata; /**< @brief simulator data */
- void *data; /**< @brief user data */
-} s_m_task_t;
+ typedef struct m_task {
+ char *name; /**< @brief task name if any */
+ simdata_task_t simdata; /**< @brief simulator data */
+ void *data; /**< @brief user data */
+ } s_m_task_t;
/** @brief Task datatype
@ingroup m_datatypes_management
@@ -54,7 +54,7 @@ typedef struct m_task {
data.
\see m_task_management
@{ */
-typedef struct m_task *m_task_t;
+ typedef struct m_task *m_task_t;
/** \brief Default value for an uninitialized #m_task_t.
\ingroup m_datatypes_management
@@ -63,15 +63,18 @@ typedef struct m_task *m_task_t;
/** @} */
+
+
/* ****************************** Process *********************************** */
-typedef struct simdata_process *simdata_process_t;
+ typedef struct simdata_process *simdata_process_t;
/** @brief Process datatype
@ingroup m_datatypes_management_details @{ */
-typedef struct m_process {
- char *name; /**< @brief process name if any */
- simdata_process_t simdata; /**< @brief simulator data */
- void *data; /**< @brief user data */
-} s_m_process_t;
+ typedef struct m_process {
+ char *name; /**< @brief process name if any */
+ simdata_process_t simdata;
+ /**< @brief simulator data */
+ void *data; /**< @brief user data */
+ } s_m_process_t;
/** @} */
/** @brief Agent datatype
@ingroup m_datatypes_management
@@ -80,16 +83,7 @@ typedef struct m_process {
data, executing in a location.
\see m_process_management
@{ */
-typedef struct m_process *m_process_t;
-/** @} */
-
-/** @brief Agent code
- @ingroup m_datatypes_management
- The code of an agent is a m_process_code_t, i.e. a function with no arguments
- returning no value.
- \see m_process_management
- @{ */
-typedef int(*m_process_code_t)(int argc,char *argv[]) ;
+ typedef struct m_process *m_process_t;
/** @} */
/* ********************************* Channel ******************************** */
@@ -100,58 +94,49 @@ typedef int(*m_process_code_t)(int argc,char *argv[]) ;
port number does).
\see m_channel_management
@{ */
-typedef int m_channel_t;
+ typedef int m_channel_t;
/** @} */
+/* ******************************** Mailbox ************************************ */
+
+ typedef struct s_msg_mailbox *msg_mailbox_t;
+/** @brief Mailbox datatype
+ @ingroup m_datatypes_management_details @{ */
+
+ msg_mailbox_t MSG_mailbox_create(const char *alias);
+ void MSG_mailbox_free(void *mailbox);
+
+
+/** @} */
+
+
/* ***************************** Error handling ***************************** */
/** @brief Error handling
@ingroup m_datatypes_management
@{
*/
-typedef enum {
- MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
- MSG_WARNING, /**< @brief Mmmh! Something must be not perfectly clean. But I
+ typedef enum {
+ MSG_OK = 0,
+ /**< @brief Everything is right. Keep on going this way ! */
+ MSG_WARNING,
+ /**< @brief Mmmh! Something must be not perfectly clean. But I
may be a paranoid freak... ! */
- MSG_TRANSFER_FAILURE, /**< @brief There has been a problem during you task
+ MSG_TIMEOUT_FAILURE, /**< @brief nothing good happened before the timer you provided elapsed */
+ MSG_TRANSFER_FAILURE,
+ /**< @brief There has been a problem during you task
transfer. Either the network is down or the remote host has been
shutdown. */
- MSG_HOST_FAILURE, /**< @brief System shutdown. The host on which you are
+ MSG_HOST_FAILURE,
+ /**< @brief System shutdown. The host on which you are
running has just been rebooted. Free your datastructures and
return now !*/
- MSG_TASK_CANCELLED, /**< @brief Cancelled task. This task has been cancelled
+ MSG_TASK_CANCELLED,
+ /**< @brief Cancelled task. This task has been cancelled
by somebody!*/
- MSG_FATAL /**< @brief You've done something wrong. You'd better look at it... */
-} MSG_error_t;
+ MSG_FATAL
+ /**< @brief You've done something wrong. You'd better look at it... */
+ } MSG_error_t;
/** @} */
-
-/** @deprecated MSG verbosity
- @ingroup m_datatypes_management
-*/
-typedef enum {
- MSG_SILENT = 0,
- MSG_SOME,
- MSG_VERBOSE
-} MSG_outputmode_t;
-
-
-/** @deprecated Network sharing mechanism
- @ingroup m_datatypes_management
- @brief Sharing policy : 0 means uninitialized value
-*/
-typedef enum {
- MSG_STORE_AND_FORWARD = 1, /**< Packet level simulation of communications. Bad */
- MSG_TCP /**< Continuous model of network communications. Good */
-} MSG_sharing_t;
-
-/** @deprecated Link datatype
- * @ingroup m_datatypes_management
- * The notion of link was present in the earliest versions of MSG.
- * It was an agglomeration of communicating resources representing a set of
- * physical network links. This abstraction a disappeared because in real-life,
- * it is generally not possible to interact directly with a link...
- */
-typedef struct m_link *m_link_t;
-
-END_DECL()
+SG_END_DECL()
#endif