libmuscle.mcp.transport_server module

class libmuscle.mcp.transport_server.RequestHandler

Bases: object

Handles requests sent to a TransportServer.

TransportServers operate in terms of chunks of bytes received and sent in return. RequestHandlers interpret received chunks of bytes, handle the request, and return a chunk of bytes containing an encoded response.

close() → None

Free per-thread resources.

On shutdown of the server, this will be called by each server thread before it shuts down.

handle_request(request: bytes) → bytes

Handle a request.

Parameters:

request – A received request

Returns:

An encoded response

exception libmuscle.mcp.transport_server.ServerNotSupported

Bases: RuntimeError

class libmuscle.mcp.transport_server.TransportServer(handler: RequestHandler)

Bases: object

A server that accepts MCP connections.

This is a base class for MCP Servers. An MCP Server accepts connections over some lower-level communication protocol, receives requests and returns responses from a RequestHandler.

close() → None

Closes this server.

Stops the server listening, waits for existing clients to disconnect, then frees any other resources.

get_location() → str

Returns the location this server listens on.

Returns:

A string containing the location.