SimGrid: Mailbox Management Functions

SimGrid 3.10 Versatile Simulation of Distributed Systems

- Home page
- Online documentation
- Dev's Corner

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions
Mailbox Management Functions
MSG

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.
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.
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.

## 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

  alias | The 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

  mailbox | The mailbox where the task was sent
  task | a memory location for storing a msg_task_t.
  host | a msg_host_t host from where the task was sent
  timeout | a 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

  mailbox | The mailbox where the task was sent
  task | a memory location for storing a msg_task_t.
  host | a msg_host_t host from where the task was sent
  timeout | a timeout
  rate | a rate

Returns
  Returns MSG_OK if the task was successfully received, MSG_HOST_FAILURE, or MSG_TRANSFER_FAILURE otherwise.