libmuscle.mpp_client module

class libmuscle.mpp_client.MPPClient(locations: List[str])

Bases: object

A client that connects to an MPP server.

This client connects to a peer to retrieve messages. It uses an MCP Transport to connect.

close() → None

Closes this client.

This closes any connections this client has and/or performs other shutdown activities.

receive(receiver: Reference, timeout_handler: TimeoutHandler | None) → Tuple[Buffer, Tuple[ProfileTimestamp, ProfileTimestamp, ProfileTimestamp]]

Receive a message from a port this client connects to.

Parameters:

receiver – The receiving (local) port.

Returns:

The received message, and profiling data