/** \ingroup msg_gos_functions
* \brief Executes a task and waits for its termination.
*
- * This function is used for describing the behavior of an agent. It
+ * This function is used for describing the behavior of a process. It
* takes only one parameter.
- * \param task a #m_task_t to execute on the location on which the
- agent is running.
+ * \param task a #m_task_t to execute on the location on which the process is running.
* \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
* or #MSG_HOST_FAILURE otherwise
*/
/** \ingroup msg_gos_functions
* \brief Executes a parallel task and waits for its termination.
*
- * \param task a #m_task_t to execute on the location on which the agent is running.
+ * \param task a #m_task_t to execute on the location on which the process is running.
*
* \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
* or #MSG_HOST_FAILURE otherwise
return MSG_process_get_PID(task->simdata->sender);
}
-#ifdef MSG_USE_DEPRECATED
/** \ingroup msg_gos_functions
+ * \brief Sets the tracing category of a task.
+ *
+ * This function should be called after the creation of
+ * a MSG task, to define the category of that task. The
+ * first parameter task must contain a task that was
+ * created with the function #MSG_task_create. The second
+ * parameter category must contain a category that was
+ * previously declared with the function #TRACE_category
+ * (or with #TRACE_category_with_color).
+ *
+ * See \ref tracing_tracing for details on how to trace
+ * the (categorized) resource utilization.
+ *
+ * \param task the task that is going to be categorized
+ * \param category the name of the category to be associated to the task
+ *
+ * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
+ */
+void MSG_task_set_category (m_task_t task, const char *category)
+{
+#ifdef HAVE_TRACING
+ TRACE_msg_set_task_category (task, category);
+#endif
+}
+
+/** \ingroup msg_gos_functions
+ *
+ * \brief Gets the current tracing category of a task.
+ *
+ * \param task the task to be considered
+ *
+ * \see MSG_task_set_category
+ *
+ * \return Returns the name of the tracing category of the given task, NULL otherwise
+ */
+const char *MSG_task_get_category (m_task_t task)
+{
+#ifdef HAVE_TRACING
+ return task->category;
+#else
+ return NULL;
+#endif
+}
+
+#ifdef MSG_USE_DEPRECATED
+/** \ingroup msg_deprecated_functions
*
* \brief Return the last value returned by a MSG function (except
* MSG_get_errno...).
return PROCESS_GET_ERRNO();
}
-/** \ingroup msg_gos_functions
+/** \ingroup msg_deprecated_functions
* \brief Put a task on a channel of an host and waits for the end of the
* transmission.
*
- * This function is used for describing the behavior of an agent. It
+ * This function is used for describing the behavior of a process. It
* takes three parameter.
* \param task a #m_task_t to send on another location. This task
will not be usable anymore when the function will return. There is
can be transfered iff it has been correctly created with
MSG_task_create().
* \param dest the destination of the message
- * \param channel the channel on which the agent should put this
+ * \param channel the channel on which the process should put this
task. This value has to be >=0 and < than the maximal number of
channels fixed with MSG_set_channel_number().
* \return #MSG_HOST_FAILURE if the host on which
return MSG_task_put_with_timeout(task, dest, channel, -1.0);
}
-/** \ingroup msg_gos_functions
+/** \ingroup msg_deprecated_functions
* \brief Does exactly the same as MSG_task_put but with a bounded transmition
* rate.
*
return MSG_task_put(task, dest, channel);
}
-/** \ingroup msg_gos_functions \brief Put a task on a channel of an
+/** \ingroup msg_deprecated_functions
+ *
+ * \brief Put a task on a channel of an
* host (with a timeout on the waiting of the destination host) and
* waits for the end of the transmission.
*
- * This function is used for describing the behavior of an agent. It
+ * This function is used for describing the behavior of a process. It
* takes four parameter.
* \param task a #m_task_t to send on another location. This task
will not be usable anymore when the function will return. There is
can be transfered iff it has been correctly created with
MSG_task_create().
* \param dest the destination of the message
- * \param channel the channel on which the agent should put this
+ * \param channel the channel on which the process should put this
task. This value has to be >=0 and < than the maximal number of
channels fixed with MSG_set_channel_number().
* \param timeout the maximum time to wait for a task before giving
(dest, channel), task, timeout);
}
-/** \ingroup msg_gos_functions
+/** \ingroup msg_deprecated_functions
* \brief Test whether there is a pending communication on a channel, and who sent it.
*
* It takes one parameter.
- * \param channel the channel on which the agent should be
+ * \param channel the channel on which the process should be
listening. This value has to be >=0 and < than the maximal
number of channels fixed with MSG_set_channel_number().
* \return -1 if there is no pending communication and the PID of the process who sent it otherwise
return MSG_process_get_PID(task->simdata->sender);
}
-/** \ingroup msg_gos_functions
+/** \ingroup msg_deprecated_functions
* \brief Test whether there is a pending communication on a channel.
*
* It takes one parameter.
- * \param channel the channel on which the agent should be
+ * \param channel the channel on which the process should be
listening. This value has to be >=0 and < than the maximal
number of channels fixed with MSG_set_channel_number().
* \return 1 if there is a pending communication and 0 otherwise
(MSG_host_self(), channel));
}
-/** \ingroup msg_gos_functions
+/** \ingroup msg_deprecated_functions
* \brief Return the number of tasks waiting to be received on a \a
channel and sent by \a host.
*
* It takes two parameters.
- * \param channel the channel on which the agent should be
+ * \param channel the channel on which the process should be
listening. This value has to be >=0 and < than the maximal
number of channels fixed with MSG_set_channel_number().
* \param host the host that is to be watched.
}
-/** \ingroup msg_gos_functions
+/** \ingroup msg_deprecated_functions
* \brief Listen on \a channel and waits for receiving a task from \a host.
*
* It takes three parameters.
hold a task when this function will return. Thus \a task should not
be equal to \c NULL and \a *task should be equal to \c NULL. If one of
those two condition does not hold, there will be a warning message.
- * \param channel the channel on which the agent should be
+ * \param channel the channel on which the process should be
listening. This value has to be >=0 and < than the maximal
number of channels fixed with MSG_set_channel_number().
* \param host the host that is to be watched.
return MSG_task_get_ext(task, channel, -1, host);
}
-/** \ingroup msg_gos_functions
+/** \ingroup msg_deprecated_functions
* \brief Listen on a channel and wait for receiving a task.
*
* It takes two parameters.
hold a task when this function will return. Thus \a task should not
be equal to \c NULL and \a *task should be equal to \c NULL. If one of
those two condition does not hold, there will be a warning message.
- * \param channel the channel on which the agent should be
+ * \param channel the channel on which the process should be
listening. This value has to be >=0 and < than the maximal
number of channels fixed with MSG_set_channel_number().
* \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
return MSG_task_get_with_timeout(task, channel, -1);
}
-/** \ingroup msg_gos_functions
+/** \ingroup msg_deprecated_functions
* \brief Listen on a channel and wait for receiving a task with a timeout.
*
* It takes three parameters.
hold a task when this function will return. Thus \a task should not
be equal to \c NULL and \a *task should be equal to \c NULL. If one of
those two condition does not hold, there will be a warning message.
- * \param channel the channel on which the agent should be
+ * \param channel the channel on which the process should be
listening. This value has to be >=0 and < than the maximal
number of channels fixed with MSG_set_channel_number().
* \param max_duration the maximum time to wait for a task before giving
