Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
improve the doc of MSG datatypes (and dispatch them in the relevant modules)
[simgrid.git] / include / msg / msg.h
index c1c2d1d..4dccee2 100644 (file)
 
 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, ...);