EclypseMPI.send#

EclypseMPI.send(recipient_ids, body, timestamp=None)[source]

Sends a message to a single recipient or multiple recipients.

When awaited, the total wait time is the communication cost between the sender and the recipient in the case of a unicast, and the maximum communication cost among the interactions with the recipients in the case of a multicast. The result of this method must be awaited.

Parameters:
  • recipient_ids (str | list[str] | None) – The ids of the recipients. If a single id is specified, the message is sent to a single recipient. If a list of ids is specified, the message is sent to multiple recipients.

  • body (dict[str, Any]) – The data to be sent. It must be a pickleable object.

  • timestamp (datetime.datetime | None, optional) – The timestamp of the message. Defaults to datetime.datetime.now().

Returns:

The MPI request.

Return type:

UnicastRequest | MulticastRequest