libmuscle.mcp.pipe_client module

class libmuscle.mcp.pipe_client.PipeClient(instance_id: Reference, location: str)

Bases: Client

A client for pipe-based communication.

Creates a PipeClient.

Parameters

• instance_id – Our instance id.

• peer_id – Id of the peer (server) we’re connecting to.

static can_connect_to(location: str) → bool

Whether this client class can connect to the given location.

Parameters

location – The location to potentially connect to.

Returns

True iff this class can connect to this location.

close() → None

Closes this client.

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

receive(receiver: Reference) → bytes

Receive a message from a port this client connects to.

Parameters

receiver – The receiving (local) port.

Returns

The received message.

static shutdown(instance_id: Reference) → None

Free any resources shared by all clients for this instance.