networking#

client#

class RequestClient(name: str, sockets: Sockets | None = None)#

Bases: object

close()#

static raise_on_invalid_message(message, valid_messages: Type[Message] | Tuple[Type[Message], ...] | None = None)#

request(address, msg, *, valid_responses: Type[Message] | Tuple[Type[Message], ...] | None = None)#

class Sockets(socket_factory=<function get_message_socket>)#

Bases: object

close(linger=-1)#

get(name: str, address: str)#

stream#

class BaseSocket(socket: zmq.sugar.socket.Socket)#

Bases: Generic[T]

recv() → T#

send(payload: T)#

socket: Socket#

class MessageDealerSocket(socket: Socket)#: Bases: MessageSocket[Message]

class MessageReqSocket(socket: Socket)#: Bases: MessageSocket[Message]

class MessageRouterSocket(socket: Socket)#

Bases: MessageSocket[Tuple[str, Message]]

make_send(identifier: str)#: create a send function that a can be used to send a message to a specific client connected to the ZMQ Router

class MessageSocket(socket: Socket)#

Bases: BaseSocket[T]

bind(addr: str)#

close(linger: int = -1)#

connect(addr: str)#

static parse_bytes(payload)#

recv() → T#

send(payload: T)#: serialize identifier and message into MultipartMessage

class Stream(socket: BaseSocket[T], logger: Logger | None = None)#

Bases: Generic[T]

recv() → T#

run()#

send(payload: T)#

set_handler(handler: Callable[[T], None]) → None#

get_message_socket(socket_type: int, context=None, ident: bytes | None = None, **kwargs)#

Module contents#

class MessageDealerSocket(socket: Socket)#: Bases: MessageSocket[Message]

class MessageReqSocket(socket: Socket)#: Bases: MessageSocket[Message]

class MessageRouterSocket(socket: Socket)#

Bases: MessageSocket[Tuple[str, Message]]

make_send(identifier: str)#: create a send function that a can be used to send a message to a specific client connected to the ZMQ Router

class RequestClient(name: str, sockets: Sockets | None = None)#

Bases: object

close()#

static raise_on_invalid_message(message, valid_messages: Type[Message] | Tuple[Type[Message], ...] | None = None)#

request(address, msg, *, valid_responses: Type[Message] | Tuple[Type[Message], ...] | None = None)#

class Sockets(socket_factory=<function get_message_socket>)#

Bases: object

close(linger=-1)#

get(name: str, address: str)#

class Stream(socket: BaseSocket[T], logger: Logger | None = None)#

Bases: Generic[T]

recv() → T#

run()#

send(payload: T)#

set_handler(handler: Callable[[T], None]) → None#

get_message_socket(socket_type: int, context=None, ident: bytes | None = None, **kwargs)#