SimGrid  3.11
Versatile Simulation of Distributed Systems
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Mailbox Management Functions

This section describes the mailbox structure of MSG (msg_mailbox_t) and the functions for managing it. More...

Functions

void MSG_mailbox_set_async (const char *alias)
 Set the mailbox to receive in asynchronous mode. More...
 
msg_error_t MSG_mailbox_get_task_ext (msg_mailbox_t mailbox, msg_task_t *task, msg_host_t host, double timeout)
 Get a task from a mailbox on a given host. More...
 
msg_error_t MSG_mailbox_get_task_ext_bounded (msg_mailbox_t mailbox, msg_task_t *task, msg_host_t host, double timeout, double rate)
 Get a task from a mailbox on a given host at a given rate. More...
 

Detailed Description

This section describes the mailbox structure of MSG (msg_mailbox_t) and the functions for managing it.

Function Documentation

void MSG_mailbox_set_async ( const char *  alias)

Set the mailbox to receive in asynchronous mode.

All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call. The receive call will still be necessary to use the received data. If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.

Parameters
aliasThe name of the mailbox
msg_error_t MSG_mailbox_get_task_ext ( msg_mailbox_t  mailbox,
msg_task_t task,
msg_host_t  host,
double  timeout 
)

Get a task from a mailbox on a given host.

Parameters
mailboxThe mailbox where the task was sent
taska memory location for storing a msg_task_t.
hosta msg_host_t host from where the task was sent
timeouta timeout
Returns
Returns MSG_OK if the task was successfully received, MSG_HOST_FAILURE, or MSG_TRANSFER_FAILURE otherwise.
msg_error_t MSG_mailbox_get_task_ext_bounded ( msg_mailbox_t  mailbox,
msg_task_t task,
msg_host_t  host,
double  timeout,
double  rate 
)

Get a task from a mailbox on a given host at a given rate.

Parameters
mailboxThe mailbox where the task was sent
taska memory location for storing a msg_task_t.
hosta msg_host_t host from where the task was sent
timeouta timeout
ratea rate
Returns
Returns MSG_OK if the task was successfully received, MSG_HOST_FAILURE, or MSG_TRANSFER_FAILURE otherwise.