X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b423e899ab6e257d5c2cf489585ad5ca0af21724..104ec12984d49e726b38234c5d8ecbfd3732b91e:/include/msg/datatypes.h diff --git a/include/msg/datatypes.h b/include/msg/datatypes.h index fd06f2f44b..1d02d0ad8a 100644 --- a/include/msg/datatypes.h +++ b/include/msg/datatypes.h @@ -12,9 +12,11 @@ SG_BEGIN_DECL() /* ******************************** Host ************************************ */ + /** @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 { @@ -22,6 +24,7 @@ typedef struct m_host { simdata_host_t simdata; /**< @brief simulator data */ void *data; /**< @brief user data */ } s_m_host_t; + /** @brief Host datatype @ingroup m_datatypes_management @@ -36,9 +39,11 @@ typedef struct m_host { @{ */ typedef struct m_host *m_host_t; /** @} */ + /* ******************************** Task ************************************ */ typedef struct simdata_task *simdata_task_t; + /** @brief Task datatype @ingroup m_datatypes_management_details */ typedef struct m_task { @@ -50,6 +55,7 @@ typedef struct m_task { char *category; /* task category for instrumentation */ #endif } s_m_task_t; + /** @brief Task datatype @ingroup m_datatypes_management @@ -60,35 +66,32 @@ typedef struct m_task { @{ */ typedef struct m_task *m_task_t; +/** + * \brief @brief Communication action + * \ingroup m_datatypes_management + * + * Communication actions transfer tasks between processes. + * For a given task, the sender and the receiver have distinct objects. + */ +typedef struct msg_comm *msg_comm_t; + /** \brief Default value for an uninitialized #m_task_t. \ingroup m_datatypes_management */ #define MSG_TASK_UNINITIALIZED NULL -typedef struct s_smx_action *msg_comm_t; /** @} */ - - /* ****************************** Process *********************************** */ -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; -/** @} */ -/** @brief Agent datatype + +/** @brief Process datatype @ingroup m_datatypes_management - An agent may be defined as a code, with some private + A process may be defined as a code, with some private data, executing in a location. \see m_process_management @{ */ -typedef struct m_process *m_process_t; +typedef struct s_smx_process *m_process_t; /** @} */ /* ********************************* Channel ******************************** */ @@ -128,9 +131,10 @@ typedef enum { MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are running has just been rebooted. Free your datastructures and return now !*/ - MSG_TASK_CANCELLED = 8, /**< @brief Canceled task. This task has been canceled by somebody!*/ + MSG_TASK_CANCELED = 8, /**< @brief Canceled task. This task has been canceled by somebody!*/ } MSG_error_t; /** @} */ + SG_END_DECL() #endif