Python: package runtimepy.net.stream

runtimepy.net.stream

index
/home/vkottler/src/vkottler/workspace/runtimepy/runtimepy/net/stream/__init__.py

A module aggregating stream-oriented connection interfaces.

Package Contents

Classes

runtimepy.net.connection.Connection(runtimepy.mixins.logging.LoggerMixinLevelControl, runtimepy.mixins.environment.ChannelEnvironmentMixin, abc.ABC)

runtimepy.net.stream.base.PrefixedMessageConnection

EchoMessageConnection

TcpPrefixedMessageConnection(runtimepy.net.stream.base.PrefixedMessageConnection, runtimepy.net.tcp.connection.TcpConnection)

EchoTcpMessageConnection(TcpPrefixedMessageConnection, EchoMessageConnection)

UdpPrefixedMessageConnection(runtimepy.net.stream.base.PrefixedMessageConnection, runtimepy.net.udp.connection.UdpConnection)

EchoUdpMessageConnection(UdpPrefixedMessageConnection, EchoMessageConnection)

runtimepy.net.stream.string.StringMessageConnection

TcpStringMessageConnection(runtimepy.net.stream.string.StringMessageConnection, runtimepy.net.tcp.connection.TcpConnection)
UdpStringMessageConnection(runtimepy.net.stream.string.StringMessageConnection, UdpPrefixedMessageConnection)

class EchoMessageConnection(runtimepy.net.stream.base.PrefixedMessageConnection)

EchoMessageConnection(logger: Union[logging.Logger, logging.LoggerAdapter[Any]], env: runtimepy.channel.environment.ChannelEnvironment = None, add_metrics: bool = True) -> None

A connection that just echoes what it was sent.

Method resolution order:: EchoMessageConnection; runtimepy.net.stream.base.PrefixedMessageConnection; runtimepy.net.connection.Connection; runtimepy.mixins.logging.LoggerMixinLevelControl; vcorelib.logging.LoggerMixin; runtimepy.mixins.environment.ChannelEnvironmentMixin; abc.ABC; builtins.object

Methods defined here:

async process_single(self, stream: <class 'BinaryIO'>, addr: Tuple[str, int] = None) -> bool: Process a single message.

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {}

Methods inherited from runtimepy.net.stream.base.PrefixedMessageConnection:

init(self) -> None: Initialize this instance.

async process_binary(self, data: bytes, addr: tuple[str, int] = None) -> bool: Process an incoming message.

send_message(self, data: Union[bytes, bytearray, memoryview], addr: tuple[str, int] = None) -> None: Handle inter-message prefixes for outgoing messages.

send_message_str(self, data: str, addr: tuple[str, int] = None) -> None: Convert a message to bytes before sending.

Methods inherited from runtimepy.net.connection.Connection:

__init__(self, logger: Union[logging.Logger, logging.LoggerAdapter[Any]], env: runtimepy.channel.environment.ChannelEnvironment = None, add_metrics: bool = True) -> None: Initialize this connection.

async async_init(self) -> bool: A runtime initialization routine (executes during 'process').

async close(self) -> None: Close this connection.

disable(self, reason: str) -> None: Disable this connection.

disable_extra(self) -> None: Additional tasks to perform when disabling.

async disable_in(self, time: float) -> None: A method for disabling a connection after some delay.

log_metrics(self, label: str = 'conn') -> None: Log connection metrics.

async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None: Process tasks for this connection while the connection is active.

async process_text(self, data: str) -> bool: Process a text frame.

async restart(self) -> bool: Reset necessary underlying state for this connection to 'process'
again.

send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None: Enqueue a binary message tos end.

send_text(self, data: str) -> None: Enqueue a text message to send.

Readonly properties inherited from runtimepy.net.connection.Connection:

auto_restart: Determine if this connection should be automatically restarted.

disabled: Determine if this connection is disabled.

Data and other attributes inherited from runtimepy.net.connection.Connection:

byte_order = <ByteOrder.NETWORK: 4>

connected = True

default_auto_restart = False

uses_binary_tx_queue = True

uses_text_tx_queue = True

Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:

setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None: Add a commandable log-level channel to the environment.

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:

register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None: Register individual channel metrics.

register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None: Register connection metrics.

register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None: Register periodic task metrics.

class EchoTcpMessageConnection(TcpPrefixedMessageConnection, EchoMessageConnection)

EchoTcpMessageConnection(transport: asyncio.transports.Transport, protocol: runtimepy.net.tcp.protocol.QueueProtocol) -> None

A connection that just echoes what it was sent.

Method resolution order:: EchoTcpMessageConnection; TcpPrefixedMessageConnection; EchoMessageConnection; runtimepy.net.stream.base.PrefixedMessageConnection; runtimepy.net.tcp.connection.TcpConnection; runtimepy.net.connection.Connection; runtimepy.mixins.logging.LoggerMixinLevelControl; vcorelib.logging.LoggerMixin; runtimepy.mixins.environment.ChannelEnvironmentMixin; abc.ABC; runtimepy.net.mixin.TransportMixin; builtins.object

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {}

Methods inherited from EchoMessageConnection:

async process_single(self, stream: <class 'BinaryIO'>, addr: Tuple[str, int] = None) -> bool: Process a single message.

Methods inherited from runtimepy.net.stream.base.PrefixedMessageConnection:

init(self) -> None: Initialize this instance.

async process_binary(self, data: bytes, addr: tuple[str, int] = None) -> bool: Process an incoming message.

send_message(self, data: Union[bytes, bytearray, memoryview], addr: tuple[str, int] = None) -> None: Handle inter-message prefixes for outgoing messages.

send_message_str(self, data: str, addr: tuple[str, int] = None) -> None: Convert a message to bytes before sending.

Methods inherited from runtimepy.net.tcp.connection.TcpConnection:

__init__(self, transport: asyncio.transports.Transport, protocol: runtimepy.net.tcp.protocol.QueueProtocol) -> None: Initialize this TCP connection.

async close(self) -> None: Close this connection.

async restart(self) -> bool: Reset necessary underlying state for this connection to 'process'
again.

send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None: Enqueue a binary message tos end.

send_text(self, data: str) -> None: Enqueue a text message to send.

Class methods inherited from runtimepy.net.tcp.connection.TcpConnection:

async app(stop_sig: asyncio.locks.Event, callback: Callable[[~T], NoneType] = None, serving_callback: Callable[[Any], NoneType] = None, manager: runtimepy.net.manager.ConnectionManager = None, **kwargs) -> None from abc.ABCMeta: Run an application that serves new connections.

async create_connection(backoff: runtimepy.net.backoff.ExponentialBackoff = None, **kwargs) -> ~T from abc.ABCMeta: Create a TCP connection.

create_pair() -> AsyncIterator[tuple[~T, ~T]] from abc.ABCMeta: Create a connection pair.

serve(callback: Callable[[~T], NoneType] = None, **kwargs) -> AsyncIterator[Any] from abc.ABCMeta: Serve incoming connections.

Data and other attributes inherited from runtimepy.net.tcp.connection.TcpConnection:

log_alias = 'TCP'

log_prefix = ''

uses_binary_tx_queue = False

uses_text_tx_queue = False

Methods inherited from runtimepy.net.connection.Connection:

async async_init(self) -> bool: A runtime initialization routine (executes during 'process').

disable(self, reason: str) -> None: Disable this connection.

disable_extra(self) -> None: Additional tasks to perform when disabling.

async disable_in(self, time: float) -> None: A method for disabling a connection after some delay.

log_metrics(self, label: str = 'conn') -> None: Log connection metrics.

async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None: Process tasks for this connection while the connection is active.

async process_text(self, data: str) -> bool: Process a text frame.

Readonly properties inherited from runtimepy.net.connection.Connection:

auto_restart: Determine if this connection should be automatically restarted.

disabled: Determine if this connection is disabled.

Data and other attributes inherited from runtimepy.net.connection.Connection:

byte_order = <ByteOrder.NETWORK: 4>

connected = True

default_auto_restart = False

Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:

setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None: Add a commandable log-level channel to the environment.

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:

register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None: Register individual channel metrics.

register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None: Register connection metrics.

register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None: Register periodic task metrics.

Methods inherited from runtimepy.net.mixin.TransportMixin:

logger_name(self, prefix: 'str' = '') -> 'str': Get a logger name for this connection.

set_transport(self, transport: '_asyncio.BaseTransport') -> 'None': Set the transport for this instance.

Readonly properties inherited from runtimepy.net.mixin.TransportMixin:

socket: Get this instance's underlying socket.

class EchoUdpMessageConnection(UdpPrefixedMessageConnection, EchoMessageConnection)

EchoUdpMessageConnection(transport: asyncio.transports.DatagramTransport, protocol: runtimepy.net.udp.protocol.UdpQueueProtocol) -> None

A connection that just echoes what it was sent.

Method resolution order:: EchoUdpMessageConnection; UdpPrefixedMessageConnection; EchoMessageConnection; runtimepy.net.stream.base.PrefixedMessageConnection; runtimepy.net.udp.connection.UdpConnection; runtimepy.net.connection.Connection; runtimepy.mixins.logging.LoggerMixinLevelControl; vcorelib.logging.LoggerMixin; runtimepy.mixins.environment.ChannelEnvironmentMixin; abc.ABC; runtimepy.net.mixin.TransportMixin; builtins.object

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {}

Methods inherited from UdpPrefixedMessageConnection:

async process_datagram(self, data: bytes, addr: Tuple[str, int]) -> bool: Process a datagram.

Methods inherited from EchoMessageConnection:

async process_single(self, stream: <class 'BinaryIO'>, addr: Tuple[str, int] = None) -> bool: Process a single message.

Methods inherited from runtimepy.net.stream.base.PrefixedMessageConnection:

init(self) -> None: Initialize this instance.

async process_binary(self, data: bytes, addr: tuple[str, int] = None) -> bool: Process an incoming message.

send_message(self, data: Union[bytes, bytearray, memoryview], addr: tuple[str, int] = None) -> None: Handle inter-message prefixes for outgoing messages.

send_message_str(self, data: str, addr: tuple[str, int] = None) -> None: Convert a message to bytes before sending.

Methods inherited from runtimepy.net.udp.connection.UdpConnection:

__init__(self, transport: asyncio.transports.DatagramTransport, protocol: runtimepy.net.udp.protocol.UdpQueueProtocol) -> None: Initialize this UDP connection.

async close(self) -> None: Close this connection.

async restart(self) -> bool: Reset necessary underlying state for this connection to 'process'
again.

send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None: Enqueue a binary message tos end.

send_text(self, data: str) -> None: Enqueue a text message to send.

sendto(self, data: bytes, addr: Union[runtimepy.net.util.IPv4Host, runtimepy.net.util.IPv6Host, tuple[str, int]] = None) -> None: Send to a specific address.

set_remote_address(self, addr: Union[runtimepy.net.util.IPv4Host, runtimepy.net.util.IPv6Host]) -> None: Set a new remote address. Note that this doesn't interact with or
attempt to 'connect' the underlying socket. That should be done at
creation time.

Class methods inherited from runtimepy.net.udp.connection.UdpConnection:

async create_connection(connect: bool = True, **kwargs) -> ~T from abc.ABCMeta: Create a UDP connection.

async create_pair() -> tuple[~T, ~T] from abc.ABCMeta: Create a connection pair.

Data and other attributes inherited from runtimepy.net.udp.connection.UdpConnection:

uses_binary_tx_queue = False

uses_text_tx_queue = False

Methods inherited from runtimepy.net.connection.Connection:

async async_init(self) -> bool: A runtime initialization routine (executes during 'process').

disable(self, reason: str) -> None: Disable this connection.

disable_extra(self) -> None: Additional tasks to perform when disabling.

async disable_in(self, time: float) -> None: A method for disabling a connection after some delay.

log_metrics(self, label: str = 'conn') -> None: Log connection metrics.

async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None: Process tasks for this connection while the connection is active.

async process_text(self, data: str) -> bool: Process a text frame.

Readonly properties inherited from runtimepy.net.connection.Connection:

auto_restart: Determine if this connection should be automatically restarted.

disabled: Determine if this connection is disabled.

Data and other attributes inherited from runtimepy.net.connection.Connection:

byte_order = <ByteOrder.NETWORK: 4>

connected = True

default_auto_restart = False

Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:

setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None: Add a commandable log-level channel to the environment.

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:

register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None: Register individual channel metrics.

register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None: Register connection metrics.

register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None: Register periodic task metrics.

Methods inherited from runtimepy.net.mixin.TransportMixin:

logger_name(self, prefix: 'str' = '') -> 'str': Get a logger name for this connection.

set_transport(self, transport: '_asyncio.BaseTransport') -> 'None': Set the transport for this instance.

Readonly properties inherited from runtimepy.net.mixin.TransportMixin:

socket: Get this instance's underlying socket.

class PrefixedMessageConnection(runtimepy.net.connection.Connection)

PrefixedMessageConnection(logger: Union[logging.Logger, logging.LoggerAdapter[Any]], env: runtimepy.channel.environment.ChannelEnvironment = None, add_metrics: bool = True) -> None

A connection for handling inter-frame message size prefixes for some
stream-oriented protocols.

Method resolution order:: PrefixedMessageConnection; runtimepy.net.connection.Connection; runtimepy.mixins.logging.LoggerMixinLevelControl; vcorelib.logging.LoggerMixin; runtimepy.mixins.environment.ChannelEnvironmentMixin; abc.ABC; builtins.object

Methods defined here:

init(self) -> None: Initialize this instance.

async process_binary(self, data: bytes, addr: tuple[str, int] = None) -> bool: Process an incoming message.

async process_single(self, stream: <class 'BinaryIO'>, addr: tuple[str, int] = None) -> bool: Process a single message.

send_message(self, data: Union[bytes, bytearray, memoryview], addr: tuple[str, int] = None) -> None: Handle inter-message prefixes for outgoing messages.

send_message_str(self, data: str, addr: tuple[str, int] = None) -> None: Convert a message to bytes before sending.

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {'processor': <class 'runtimepy.message.MessageProcessor'>}

Methods inherited from runtimepy.net.connection.Connection:

__init__(self, logger: Union[logging.Logger, logging.LoggerAdapter[Any]], env: runtimepy.channel.environment.ChannelEnvironment = None, add_metrics: bool = True) -> None: Initialize this connection.

async async_init(self) -> bool: A runtime initialization routine (executes during 'process').

async close(self) -> None: Close this connection.

disable(self, reason: str) -> None: Disable this connection.

disable_extra(self) -> None: Additional tasks to perform when disabling.

async disable_in(self, time: float) -> None: A method for disabling a connection after some delay.

log_metrics(self, label: str = 'conn') -> None: Log connection metrics.

async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None: Process tasks for this connection while the connection is active.

async process_text(self, data: str) -> bool: Process a text frame.

async restart(self) -> bool: Reset necessary underlying state for this connection to 'process'
again.

send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None: Enqueue a binary message tos end.

send_text(self, data: str) -> None: Enqueue a text message to send.

Readonly properties inherited from runtimepy.net.connection.Connection:

auto_restart: Determine if this connection should be automatically restarted.

disabled: Determine if this connection is disabled.

Data and other attributes inherited from runtimepy.net.connection.Connection:

byte_order = <ByteOrder.NETWORK: 4>

connected = True

default_auto_restart = False

uses_binary_tx_queue = True

uses_text_tx_queue = True

Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:

setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None: Add a commandable log-level channel to the environment.

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:

register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None: Register individual channel metrics.

register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None: Register connection metrics.

register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None: Register periodic task metrics.

class StringMessageConnection(runtimepy.net.stream.base.PrefixedMessageConnection)

StringMessageConnection(logger: Union[logging.Logger, logging.LoggerAdapter[Any]], env: runtimepy.channel.environment.ChannelEnvironment = None, add_metrics: bool = True) -> None

A simple string-message sending and processing connection.

Method resolution order:: StringMessageConnection; runtimepy.net.stream.base.PrefixedMessageConnection; runtimepy.net.connection.Connection; runtimepy.mixins.logging.LoggerMixinLevelControl; vcorelib.logging.LoggerMixin; runtimepy.mixins.environment.ChannelEnvironmentMixin; abc.ABC; builtins.object

Methods defined here:

async process_message(self, data: str, addr: Tuple[str, int] = None) -> bool: Process a string message.

async process_single(self, stream: <class 'BinaryIO'>, addr: Tuple[str, int] = None) -> bool: Process a single message.

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {}

Methods inherited from runtimepy.net.stream.base.PrefixedMessageConnection:

init(self) -> None: Initialize this instance.

async process_binary(self, data: bytes, addr: tuple[str, int] = None) -> bool: Process an incoming message.

send_message(self, data: Union[bytes, bytearray, memoryview], addr: tuple[str, int] = None) -> None: Handle inter-message prefixes for outgoing messages.

send_message_str(self, data: str, addr: tuple[str, int] = None) -> None: Convert a message to bytes before sending.

Methods inherited from runtimepy.net.connection.Connection:

__init__(self, logger: Union[logging.Logger, logging.LoggerAdapter[Any]], env: runtimepy.channel.environment.ChannelEnvironment = None, add_metrics: bool = True) -> None: Initialize this connection.

async async_init(self) -> bool: A runtime initialization routine (executes during 'process').

async close(self) -> None: Close this connection.

disable(self, reason: str) -> None: Disable this connection.

disable_extra(self) -> None: Additional tasks to perform when disabling.

async disable_in(self, time: float) -> None: A method for disabling a connection after some delay.

log_metrics(self, label: str = 'conn') -> None: Log connection metrics.

async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None: Process tasks for this connection while the connection is active.

async process_text(self, data: str) -> bool: Process a text frame.

async restart(self) -> bool: Reset necessary underlying state for this connection to 'process'
again.

send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None: Enqueue a binary message tos end.

send_text(self, data: str) -> None: Enqueue a text message to send.

Readonly properties inherited from runtimepy.net.connection.Connection:

auto_restart: Determine if this connection should be automatically restarted.

disabled: Determine if this connection is disabled.

Data and other attributes inherited from runtimepy.net.connection.Connection:

byte_order = <ByteOrder.NETWORK: 4>

connected = True

default_auto_restart = False

uses_binary_tx_queue = True

uses_text_tx_queue = True

Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:

setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None: Add a commandable log-level channel to the environment.

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:

register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None: Register individual channel metrics.

register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None: Register connection metrics.

register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None: Register periodic task metrics.

class TcpPrefixedMessageConnection(runtimepy.net.stream.base.PrefixedMessageConnection, runtimepy.net.tcp.connection.TcpConnection)

TcpPrefixedMessageConnection(transport: asyncio.transports.Transport, protocol: runtimepy.net.tcp.protocol.QueueProtocol) -> None

A TCP implementation for size-prefixed messages.

Method resolution order:: TcpPrefixedMessageConnection; runtimepy.net.stream.base.PrefixedMessageConnection; runtimepy.net.tcp.connection.TcpConnection; runtimepy.net.connection.Connection; runtimepy.mixins.logging.LoggerMixinLevelControl; vcorelib.logging.LoggerMixin; runtimepy.mixins.environment.ChannelEnvironmentMixin; abc.ABC; runtimepy.net.mixin.TransportMixin; builtins.object

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {}

Methods inherited from runtimepy.net.stream.base.PrefixedMessageConnection:

init(self) -> None: Initialize this instance.

async process_binary(self, data: bytes, addr: tuple[str, int] = None) -> bool: Process an incoming message.

async process_single(self, stream: <class 'BinaryIO'>, addr: tuple[str, int] = None) -> bool: Process a single message.

send_message(self, data: Union[bytes, bytearray, memoryview], addr: tuple[str, int] = None) -> None: Handle inter-message prefixes for outgoing messages.

send_message_str(self, data: str, addr: tuple[str, int] = None) -> None: Convert a message to bytes before sending.

Methods inherited from runtimepy.net.tcp.connection.TcpConnection:

__init__(self, transport: asyncio.transports.Transport, protocol: runtimepy.net.tcp.protocol.QueueProtocol) -> None: Initialize this TCP connection.

async close(self) -> None: Close this connection.

async restart(self) -> bool: Reset necessary underlying state for this connection to 'process'
again.

send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None: Enqueue a binary message tos end.

send_text(self, data: str) -> None: Enqueue a text message to send.

Class methods inherited from runtimepy.net.tcp.connection.TcpConnection:

async app(stop_sig: asyncio.locks.Event, callback: Callable[[~T], NoneType] = None, serving_callback: Callable[[Any], NoneType] = None, manager: runtimepy.net.manager.ConnectionManager = None, **kwargs) -> None from abc.ABCMeta: Run an application that serves new connections.

async create_connection(backoff: runtimepy.net.backoff.ExponentialBackoff = None, **kwargs) -> ~T from abc.ABCMeta: Create a TCP connection.

create_pair() -> AsyncIterator[tuple[~T, ~T]] from abc.ABCMeta: Create a connection pair.

serve(callback: Callable[[~T], NoneType] = None, **kwargs) -> AsyncIterator[Any] from abc.ABCMeta: Serve incoming connections.

Data and other attributes inherited from runtimepy.net.tcp.connection.TcpConnection:

log_alias = 'TCP'

log_prefix = ''

uses_binary_tx_queue = False

uses_text_tx_queue = False

Methods inherited from runtimepy.net.connection.Connection:

async async_init(self) -> bool: A runtime initialization routine (executes during 'process').

disable(self, reason: str) -> None: Disable this connection.

disable_extra(self) -> None: Additional tasks to perform when disabling.

async disable_in(self, time: float) -> None: A method for disabling a connection after some delay.

log_metrics(self, label: str = 'conn') -> None: Log connection metrics.

async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None: Process tasks for this connection while the connection is active.

async process_text(self, data: str) -> bool: Process a text frame.

Readonly properties inherited from runtimepy.net.connection.Connection:

auto_restart: Determine if this connection should be automatically restarted.

disabled: Determine if this connection is disabled.

Data and other attributes inherited from runtimepy.net.connection.Connection:

byte_order = <ByteOrder.NETWORK: 4>

connected = True

default_auto_restart = False

Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:

setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None: Add a commandable log-level channel to the environment.

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:

register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None: Register individual channel metrics.

register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None: Register connection metrics.

register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None: Register periodic task metrics.

Methods inherited from runtimepy.net.mixin.TransportMixin:

logger_name(self, prefix: 'str' = '') -> 'str': Get a logger name for this connection.

set_transport(self, transport: '_asyncio.BaseTransport') -> 'None': Set the transport for this instance.

Readonly properties inherited from runtimepy.net.mixin.TransportMixin:

socket: Get this instance's underlying socket.

class TcpStringMessageConnection(runtimepy.net.stream.string.StringMessageConnection, runtimepy.net.tcp.connection.TcpConnection)

TcpStringMessageConnection(transport: asyncio.transports.Transport, protocol: runtimepy.net.tcp.protocol.QueueProtocol) -> None

A simple string-message sending and processing connection using TCP.

Method resolution order:: TcpStringMessageConnection; runtimepy.net.stream.string.StringMessageConnection; runtimepy.net.stream.base.PrefixedMessageConnection; runtimepy.net.tcp.connection.TcpConnection; runtimepy.net.connection.Connection; runtimepy.mixins.logging.LoggerMixinLevelControl; vcorelib.logging.LoggerMixin; runtimepy.mixins.environment.ChannelEnvironmentMixin; abc.ABC; runtimepy.net.mixin.TransportMixin; builtins.object

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {}

Methods inherited from runtimepy.net.stream.string.StringMessageConnection:

async process_message(self, data: str, addr: Tuple[str, int] = None) -> bool: Process a string message.

async process_single(self, stream: <class 'BinaryIO'>, addr: Tuple[str, int] = None) -> bool: Process a single message.

Methods inherited from runtimepy.net.stream.base.PrefixedMessageConnection:

init(self) -> None: Initialize this instance.

async process_binary(self, data: bytes, addr: tuple[str, int] = None) -> bool: Process an incoming message.

send_message(self, data: Union[bytes, bytearray, memoryview], addr: tuple[str, int] = None) -> None: Handle inter-message prefixes for outgoing messages.

send_message_str(self, data: str, addr: tuple[str, int] = None) -> None: Convert a message to bytes before sending.

Methods inherited from runtimepy.net.tcp.connection.TcpConnection:

__init__(self, transport: asyncio.transports.Transport, protocol: runtimepy.net.tcp.protocol.QueueProtocol) -> None: Initialize this TCP connection.

async close(self) -> None: Close this connection.

async restart(self) -> bool: Reset necessary underlying state for this connection to 'process'
again.

send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None: Enqueue a binary message tos end.

send_text(self, data: str) -> None: Enqueue a text message to send.

Class methods inherited from runtimepy.net.tcp.connection.TcpConnection:

async app(stop_sig: asyncio.locks.Event, callback: Callable[[~T], NoneType] = None, serving_callback: Callable[[Any], NoneType] = None, manager: runtimepy.net.manager.ConnectionManager = None, **kwargs) -> None from abc.ABCMeta: Run an application that serves new connections.

async create_connection(backoff: runtimepy.net.backoff.ExponentialBackoff = None, **kwargs) -> ~T from abc.ABCMeta: Create a TCP connection.

create_pair() -> AsyncIterator[tuple[~T, ~T]] from abc.ABCMeta: Create a connection pair.

serve(callback: Callable[[~T], NoneType] = None, **kwargs) -> AsyncIterator[Any] from abc.ABCMeta: Serve incoming connections.

Data and other attributes inherited from runtimepy.net.tcp.connection.TcpConnection:

log_alias = 'TCP'

log_prefix = ''

uses_binary_tx_queue = False

uses_text_tx_queue = False

Methods inherited from runtimepy.net.connection.Connection:

async async_init(self) -> bool: A runtime initialization routine (executes during 'process').

disable(self, reason: str) -> None: Disable this connection.

disable_extra(self) -> None: Additional tasks to perform when disabling.

async disable_in(self, time: float) -> None: A method for disabling a connection after some delay.

log_metrics(self, label: str = 'conn') -> None: Log connection metrics.

async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None: Process tasks for this connection while the connection is active.

async process_text(self, data: str) -> bool: Process a text frame.

Readonly properties inherited from runtimepy.net.connection.Connection:

auto_restart: Determine if this connection should be automatically restarted.

disabled: Determine if this connection is disabled.

Data and other attributes inherited from runtimepy.net.connection.Connection:

byte_order = <ByteOrder.NETWORK: 4>

connected = True

default_auto_restart = False

Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:

setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None: Add a commandable log-level channel to the environment.

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:

register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None: Register individual channel metrics.

register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None: Register connection metrics.

register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None: Register periodic task metrics.

Methods inherited from runtimepy.net.mixin.TransportMixin:

logger_name(self, prefix: 'str' = '') -> 'str': Get a logger name for this connection.

set_transport(self, transport: '_asyncio.BaseTransport') -> 'None': Set the transport for this instance.

Readonly properties inherited from runtimepy.net.mixin.TransportMixin:

socket: Get this instance's underlying socket.

class UdpPrefixedMessageConnection(runtimepy.net.stream.base.PrefixedMessageConnection, runtimepy.net.udp.connection.UdpConnection)

UdpPrefixedMessageConnection(transport: asyncio.transports.DatagramTransport, protocol: runtimepy.net.udp.protocol.UdpQueueProtocol) -> None

A UDP implementation for size-prefixed messages.

Method resolution order:: UdpPrefixedMessageConnection; runtimepy.net.stream.base.PrefixedMessageConnection; runtimepy.net.udp.connection.UdpConnection; runtimepy.net.connection.Connection; runtimepy.mixins.logging.LoggerMixinLevelControl; vcorelib.logging.LoggerMixin; runtimepy.mixins.environment.ChannelEnvironmentMixin; abc.ABC; runtimepy.net.mixin.TransportMixin; builtins.object

Methods defined here:

async process_datagram(self, data: bytes, addr: Tuple[str, int]) -> bool: Process a datagram.

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {}

Methods inherited from runtimepy.net.stream.base.PrefixedMessageConnection:

init(self) -> None: Initialize this instance.

async process_binary(self, data: bytes, addr: tuple[str, int] = None) -> bool: Process an incoming message.

async process_single(self, stream: <class 'BinaryIO'>, addr: tuple[str, int] = None) -> bool: Process a single message.

send_message(self, data: Union[bytes, bytearray, memoryview], addr: tuple[str, int] = None) -> None: Handle inter-message prefixes for outgoing messages.

send_message_str(self, data: str, addr: tuple[str, int] = None) -> None: Convert a message to bytes before sending.

Methods inherited from runtimepy.net.udp.connection.UdpConnection:

__init__(self, transport: asyncio.transports.DatagramTransport, protocol: runtimepy.net.udp.protocol.UdpQueueProtocol) -> None: Initialize this UDP connection.

async close(self) -> None: Close this connection.

async restart(self) -> bool: Reset necessary underlying state for this connection to 'process'
again.

send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None: Enqueue a binary message tos end.

send_text(self, data: str) -> None: Enqueue a text message to send.

sendto(self, data: bytes, addr: Union[runtimepy.net.util.IPv4Host, runtimepy.net.util.IPv6Host, tuple[str, int]] = None) -> None: Send to a specific address.

set_remote_address(self, addr: Union[runtimepy.net.util.IPv4Host, runtimepy.net.util.IPv6Host]) -> None: Set a new remote address. Note that this doesn't interact with or
attempt to 'connect' the underlying socket. That should be done at
creation time.

Class methods inherited from runtimepy.net.udp.connection.UdpConnection:

async create_connection(connect: bool = True, **kwargs) -> ~T from abc.ABCMeta: Create a UDP connection.

async create_pair() -> tuple[~T, ~T] from abc.ABCMeta: Create a connection pair.

Data and other attributes inherited from runtimepy.net.udp.connection.UdpConnection:

uses_binary_tx_queue = False

uses_text_tx_queue = False

Methods inherited from runtimepy.net.connection.Connection:

async async_init(self) -> bool: A runtime initialization routine (executes during 'process').

disable(self, reason: str) -> None: Disable this connection.

disable_extra(self) -> None: Additional tasks to perform when disabling.

async disable_in(self, time: float) -> None: A method for disabling a connection after some delay.

log_metrics(self, label: str = 'conn') -> None: Log connection metrics.

async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None: Process tasks for this connection while the connection is active.

async process_text(self, data: str) -> bool: Process a text frame.

Readonly properties inherited from runtimepy.net.connection.Connection:

auto_restart: Determine if this connection should be automatically restarted.

disabled: Determine if this connection is disabled.

Data and other attributes inherited from runtimepy.net.connection.Connection:

byte_order = <ByteOrder.NETWORK: 4>

connected = True

default_auto_restart = False

Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:

setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None: Add a commandable log-level channel to the environment.

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:

register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None: Register individual channel metrics.

register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None: Register connection metrics.

register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None: Register periodic task metrics.

Methods inherited from runtimepy.net.mixin.TransportMixin:

logger_name(self, prefix: 'str' = '') -> 'str': Get a logger name for this connection.

set_transport(self, transport: '_asyncio.BaseTransport') -> 'None': Set the transport for this instance.

Readonly properties inherited from runtimepy.net.mixin.TransportMixin:

socket: Get this instance's underlying socket.

class UdpStringMessageConnection(runtimepy.net.stream.string.StringMessageConnection, UdpPrefixedMessageConnection)

UdpStringMessageConnection(transport: asyncio.transports.DatagramTransport, protocol: runtimepy.net.udp.protocol.UdpQueueProtocol) -> None

A simple string-message sending and processing connection using UDP.

Method resolution order:: UdpStringMessageConnection; runtimepy.net.stream.string.StringMessageConnection; UdpPrefixedMessageConnection; runtimepy.net.stream.base.PrefixedMessageConnection; runtimepy.net.udp.connection.UdpConnection; runtimepy.net.connection.Connection; runtimepy.mixins.logging.LoggerMixinLevelControl; vcorelib.logging.LoggerMixin; runtimepy.mixins.environment.ChannelEnvironmentMixin; abc.ABC; runtimepy.net.mixin.TransportMixin; builtins.object

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {}

Methods inherited from runtimepy.net.stream.string.StringMessageConnection:

async process_message(self, data: str, addr: Tuple[str, int] = None) -> bool: Process a string message.

async process_single(self, stream: <class 'BinaryIO'>, addr: Tuple[str, int] = None) -> bool: Process a single message.

Methods inherited from UdpPrefixedMessageConnection:

async process_datagram(self, data: bytes, addr: Tuple[str, int]) -> bool: Process a datagram.

Methods inherited from runtimepy.net.stream.base.PrefixedMessageConnection:

init(self) -> None: Initialize this instance.

async process_binary(self, data: bytes, addr: tuple[str, int] = None) -> bool: Process an incoming message.

send_message(self, data: Union[bytes, bytearray, memoryview], addr: tuple[str, int] = None) -> None: Handle inter-message prefixes for outgoing messages.

send_message_str(self, data: str, addr: tuple[str, int] = None) -> None: Convert a message to bytes before sending.

Methods inherited from runtimepy.net.udp.connection.UdpConnection:

__init__(self, transport: asyncio.transports.DatagramTransport, protocol: runtimepy.net.udp.protocol.UdpQueueProtocol) -> None: Initialize this UDP connection.

async close(self) -> None: Close this connection.

async restart(self) -> bool: Reset necessary underlying state for this connection to 'process'
again.

send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None: Enqueue a binary message tos end.

send_text(self, data: str) -> None: Enqueue a text message to send.

sendto(self, data: bytes, addr: Union[runtimepy.net.util.IPv4Host, runtimepy.net.util.IPv6Host, tuple[str, int]] = None) -> None: Send to a specific address.

set_remote_address(self, addr: Union[runtimepy.net.util.IPv4Host, runtimepy.net.util.IPv6Host]) -> None: Set a new remote address. Note that this doesn't interact with or
attempt to 'connect' the underlying socket. That should be done at
creation time.

Class methods inherited from runtimepy.net.udp.connection.UdpConnection:

async create_connection(connect: bool = True, **kwargs) -> ~T from abc.ABCMeta: Create a UDP connection.

async create_pair() -> tuple[~T, ~T] from abc.ABCMeta: Create a connection pair.

Data and other attributes inherited from runtimepy.net.udp.connection.UdpConnection:

uses_binary_tx_queue = False

uses_text_tx_queue = False

Methods inherited from runtimepy.net.connection.Connection:

async async_init(self) -> bool: A runtime initialization routine (executes during 'process').

disable(self, reason: str) -> None: Disable this connection.

disable_extra(self) -> None: Additional tasks to perform when disabling.

async disable_in(self, time: float) -> None: A method for disabling a connection after some delay.

log_metrics(self, label: str = 'conn') -> None: Log connection metrics.

async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None: Process tasks for this connection while the connection is active.

async process_text(self, data: str) -> bool: Process a text frame.

Readonly properties inherited from runtimepy.net.connection.Connection:

auto_restart: Determine if this connection should be automatically restarted.

disabled: Determine if this connection is disabled.

Data and other attributes inherited from runtimepy.net.connection.Connection:

byte_order = <ByteOrder.NETWORK: 4>

connected = True

default_auto_restart = False

Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:

setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None: Add a commandable log-level channel to the environment.

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:

register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None: Register individual channel metrics.

register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None: Register connection metrics.

register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None: Register periodic task metrics.

Methods inherited from runtimepy.net.mixin.TransportMixin:

logger_name(self, prefix: 'str' = '') -> 'str': Get a logger name for this connection.

set_transport(self, transport: '_asyncio.BaseTransport') -> 'None': Set the transport for this instance.

Readonly properties inherited from runtimepy.net.mixin.TransportMixin:

socket: Get this instance's underlying socket.

Data
		__all__ = ['PrefixedMessageConnection', 'StringMessageConnection', 'TcpPrefixedMessageConnection', 'UdpPrefixedMessageConnection', 'EchoMessageConnection', 'EchoTcpMessageConnection', 'EchoUdpMessageConnection', 'TcpStringMessageConnection', 'UdpStringMessageConnection']