libmuscle.mcp.tcp_transport_client module

exception libmuscle.mcp.tcp_transport_client.NoPendingResponse

Bases: RuntimeError

class libmuscle.mcp.tcp_transport_client.TcpTransportClient(location: str)

Bases: TransportClient

A client that connects to a TCPTransport server.

call(request: Buffer, timeout_handler: TimeoutHandler | None = None) → Tuple[Buffer, Tuple[ProfileTimestamp, ProfileTimestamp, ProfileTimestamp]]

Send a request to the server and receive the response.

This is a blocking call.

Parameters:

• request – The request to send

• timeout_handler – Optional timeout handler. This is used for communication deadlock detection.

Returns:

The received response

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 performs other shutdown activities as needed.