improve the doc of MSG datatypes (and dispatch them in the relevant modules)

[simgrid.git] / include / msg / msg.h

diff --git a/include/msg/msg.h b/include/msg/msg.h
index eed0d31..4dccee2 100644 (file)
--- a/include/msg/msg.h
+++ b/include/msg/msg.h
@@ -14,6 +14,23 @@
 
 SG_BEGIN_DECL()
 
+/** @brief Return code of most MSG functions
+    @ingroup msg_simulation
+    @{ */
+/* Keep these code as binary values: java bindings manipulate | of these values */
+typedef enum {
+  MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
+  MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
+  MSG_TRANSFER_FAILURE = 2,   /**< @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 = 4,       /**< @brief System shutdown. The host on which you are
+      running has just been rebooted. Free your datastructures and
+      return now !*/
+  MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
+} MSG_error_t;
+/** @} */
+
 
 /************************** Global ******************************************/
 XBT_PUBLIC(void) MSG_config(const char *name, ...);
@@ -38,11 +55,11 @@ XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
 
 
 /************************** File handling ***********************************/
-XBT_PUBLIC(size_t) MSG_file_read(const char* storage, void* ptr, size_t size, size_t nmemb, m_file_t stream);
-XBT_PUBLIC(size_t) MSG_file_write(const char* storage, const void* ptr, size_t size, size_t nmemb, m_file_t stream);
-XBT_PUBLIC(m_file_t) MSG_file_open(const char* storage, const char* path, const char* mode);
-XBT_PUBLIC(int) MSG_file_close(const char* storage, m_file_t fp);
-XBT_PUBLIC(int) MSG_file_stat(const char* storage, int fd, void* buf);
+XBT_PUBLIC(size_t) MSG_file_read(const char* storage, void* ptr, size_t size, size_t nmemb, msg_file_t stream);
+XBT_PUBLIC(size_t) MSG_file_write(const char* storage, const void* ptr, size_t size, size_t nmemb, msg_file_t stream);
+XBT_PUBLIC(msg_file_t) MSG_file_open(const char* storage, const char* path, const char* mode);
+XBT_PUBLIC(int) MSG_file_close(const char* storage, msg_file_t fp);
+XBT_PUBLIC(int) MSG_file_stat(const char* storage, msg_file_t fd, s_msg_stat_t *buf);
 
 
 /************************** Host handling ***********************************/
@@ -206,6 +223,9 @@ XBT_PUBLIC(MSG_error_t)
 
 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
 
+XBT_PUBLIC(void) MSG_task_set_category (m_task_t task, const char *category);
+XBT_PUBLIC(const char *) MSG_task_get_category (m_task_t task);
+
 /************************** Task handling ************************************/
 XBT_PUBLIC(MSG_error_t)
     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,