-/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, "Logging specific to MSG (gos)");
-/** @ingroup msg_task_usage
+/**
* @brief Executes a task and waits for its termination.
*
* This function is used for describing the behavior of a process. It takes only one parameter.
return MSG_parallel_task_execute(task);
}
-/** @ingroup msg_task_usage
+/**
* @brief Executes a parallel task and waits for its termination.
*
* @param task a #msg_task_t to execute on the location on which the process is running.
return status;
}
-/** @ingroup msg_task_usage
+/**
* @brief Sleep for the specified number of seconds
*
* Makes the current process sleep until @a time seconds have elapsed.
return status;
}
-/** @ingroup msg_task_usage
+/**
* @brief Receives a task from a mailbox.
*
* This is a blocking function, the execution flow will be blocked until the task is received. See #MSG_task_irecv
return MSG_task_receive_with_timeout(task, alias, -1);
}
-/** @ingroup msg_task_usage
+/**
* @brief Receives a task from a mailbox at a given rate.
*
* @param task a memory location for storing a #msg_task_t.
return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
}
-/** @ingroup msg_task_usage
+/**
* @brief Receives a task from a mailbox with a given timeout.
*
* This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
return MSG_task_receive_ext(task, alias, timeout, nullptr);
}
-/** @ingroup msg_task_usage
+/**
* @brief Receives a task from a mailbox with a given timeout and at a given rate.
*
* @param task a memory location for storing a #msg_task_t.
return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate);
}
-/** @ingroup msg_task_usage
+/**
* @brief Receives a task from a mailbox from a specific host with a given timeout.
*
* This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
return MSG_task_receive_ext_bounded(task, alias, timeout, host, -1.0);
}
-/** @ingroup msg_task_usage
+/**
* @brief Receives a task from a mailbox from a specific host with a given timeout and at a given rate.
*
* @param task a memory location for storing a #msg_task_t.
return comm;
}
-/** @ingroup msg_task_usage
+/**
* @brief Sends a task on a mailbox.
*
* This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
return MSG_task_isend_internal(task, alias, nullptr, 0);
}
-/** @ingroup msg_task_usage
+/**
* @brief Sends a task on a mailbox with a maximum rate
*
* This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
return MSG_task_isend_internal(task, alias, nullptr, 0);
}
-/** @ingroup msg_task_usage
+/**
* @brief Sends a task on a mailbox.
*
* This is a non blocking detached send function.
xbt_assert(comm == nullptr);
}
-/** @ingroup msg_task_usage
+/**
* @brief Sends a task on a mailbox with a maximal rate.
*
* This is a non blocking detached send function.
MSG_task_dsend(task, alias, cleanup);
}
-/** @ingroup msg_task_usage
+/**
* @brief Starts listening for receiving a task from an asynchronous communication.
*
* This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
return MSG_task_irecv_bounded(task, name, -1.0);
}
-/** @ingroup msg_task_usage
+/**
* @brief Starts listening for receiving a task from an asynchronous communication at a given rate.
*
* The rate parameter can be used to receive a task with a limited
return comm;
}
-/** @ingroup msg_task_usage
+/**
* @brief Checks whether a communication is done, and if yes, finalizes it.
* @param comm the communication to test
* @return 'true' if the communication is finished
return finished;
}
-/** @ingroup msg_task_usage
+/**
* @brief This function checks if a communication is finished.
* @param comms a vector of communications
* @return the position of the finished communication if any
status = MSG_TIMEOUT;
}
catch (xbt_ex& e) {
- switch (e.category) {
- case network_error:
- finished_index = e.value;
- status = MSG_TRANSFER_FAILURE;
- break;
- default:
- throw;
- }
+ if (e.category != network_error)
+ throw;
+ finished_index = e.value;
+ status = MSG_TRANSFER_FAILURE;
}
if (finished_index != -1) {
return finished_index;
}
-/** @ingroup msg_task_usage
- * @brief Destroys a communication.
- * @param comm the communication to destroy.
- */
+/** @brief Destroys the provided communication. */
void MSG_comm_destroy(msg_comm_t comm)
{
delete comm;
}
-/** @ingroup msg_task_usage
- * @brief Wait for the completion of a communication.
+/** @brief Wait for the completion of a communication.
*
* It takes two parameters.
* @param comm the communication to wait.
return comm->status;
}
-/** @ingroup msg_task_usage
- * @brief This function is called by a sender and permit to wait for each communication
+/** @brief This function is called by a sender and permit to wait for each communication
*
* @param comm a vector of communication
* @param nb_elem is the size of the comm vector
MSG_comm_wait(comm[i], timeout);
}
-/** @ingroup msg_task_usage
- * @brief This function waits for the first communication finished in a list.
+/** @brief This function waits for the first communication finished in a list.
* @param comms a vector of communications
* @return the position of the first finished communication
* (but it may have failed, use MSG_comm_get_status() to know its status)
}
/**
- * @ingroup msg_task_usage
* @brief Returns the error (if any) that occurred during a finished communication.
* @param comm a finished communication
* @return the status of the communication, or #MSG_OK if no error occurred
return comm->status;
}
-/** @ingroup msg_task_usage
- * @brief Get a task (#msg_task_t) from a communication
+/** @brief Get a task (#msg_task_t) from a communication
*
* @param comm the communication where to get the task
* @return the task from the communication
// notify the user callback if any
if (msg_global->task_copy_callback) {
msg_task_t task = static_cast<msg_task_t>(buff);
- msg_global->task_copy_callback(task, comm->src_proc->ciface(), comm->dst_proc->ciface());
+ msg_global->task_copy_callback(task, comm->src_actor_->ciface(), comm->dst_actor_->ciface());
}
}
-/** @ingroup msg_task_usage
+/**
* @brief Sends a task to a mailbox
*
* This is a blocking function, the execution flow will be blocked until the task is sent (and received on the other
return MSG_task_send_with_timeout(task, alias, -1);
}
-/** @ingroup msg_task_usage
+/**
* @brief Sends a task to a mailbox with a maximum rate
*
* This is a blocking function, the execution flow will be blocked until the task is sent. The maxrate parameter allows
return MSG_task_send(task, alias);
}
-/** @ingroup msg_task_usage
+/**
* @brief Sends a task to a mailbox with a timeout
*
* This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
return ret;
}
-/** @ingroup msg_task_usage
+/**
* @brief Sends a task to a mailbox with a timeout and with a maximum rate
*
* This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
return MSG_task_send_with_timeout(task, alias, timeout);
}
-/** @ingroup msg_task_usage
+/**
* @brief Look if there is a communication on a mailbox and return the PID of the sender process.
*
* @param alias the name of the mailbox to be considered
if (not comm)
return -1;
- return MSG_process_get_PID(static_cast<msg_task_t>(comm->src_buff)->simdata->sender);
+ return MSG_process_get_PID(static_cast<msg_task_t>(comm->src_buff_)->simdata->sender);
}
-/** @ingroup msg_task_usage
+/**
* @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
TRACE_msg_set_task_category (task, category);
}
-/** @ingroup msg_task_usage
- *
+/**
* @brief Gets the current tracing category of a task.
*
* @param task the task to be considered
