| | |
- runtimepy.net.connection.Connection(runtimepy.mixins.logging.LoggerMixinLevelControl, runtimepy.mixins.environment.ChannelEnvironmentMixin, abc.ABC)
-
- UdpConnection(runtimepy.net.connection.Connection, runtimepy.net.mixin.TransportMixin)
-
- EchoUdpConnection(UdpConnection, runtimepy.net.connection.EchoConnection)
- NullUdpConnection(UdpConnection, runtimepy.net.connection.NullConnection)
- runtimepy.net.mixin.TransportMixin(builtins.object)
-
- UdpConnection(runtimepy.net.connection.Connection, runtimepy.net.mixin.TransportMixin)
-
- EchoUdpConnection(UdpConnection, runtimepy.net.connection.EchoConnection)
- NullUdpConnection(UdpConnection, runtimepy.net.connection.NullConnection)
class EchoUdpConnection(UdpConnection, runtimepy.net.connection.EchoConnection) |
| |
EchoUdpConnection(transport: asyncio.transports.DatagramTransport, protocol: runtimepy.net.udp.protocol.UdpQueueProtocol) -> None
An echo connection for UDP.
|
| |
- Method resolution order:
- EchoUdpConnection
- UdpConnection
- runtimepy.net.connection.EchoConnection
- 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 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 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 UdpConnection:
- uses_binary_tx_queue = False
- uses_text_tx_queue = False
Methods inherited from runtimepy.net.connection.EchoConnection:
- async process_binary(self, data: bytes) -> bool
- Process a binary frame.
- async process_text(self, data: str) -> bool
- Process a text frame.
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.
- init(self) -> None
- Initialize this instance.
- 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.
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 NullUdpConnection(UdpConnection, runtimepy.net.connection.NullConnection) |
| |
NullUdpConnection(transport: asyncio.transports.DatagramTransport, protocol: runtimepy.net.udp.protocol.UdpQueueProtocol) -> None
A null UDP connection.
|
| |
- Method resolution order:
- NullUdpConnection
- UdpConnection
- runtimepy.net.connection.NullConnection
- 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 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 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 UdpConnection:
- uses_binary_tx_queue = False
- uses_text_tx_queue = False
Methods inherited from runtimepy.net.connection.NullConnection:
- async process_binary(self, data: bytes) -> bool
- Process a binary frame.
- async process_text(self, data: str) -> bool
- Process a text frame.
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.
- init(self) -> None
- Initialize this instance.
- 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.
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 UdpConnection(runtimepy.net.connection.Connection, runtimepy.net.mixin.TransportMixin) |
| |
UdpConnection(transport: asyncio.transports.DatagramTransport, protocol: runtimepy.net.udp.protocol.UdpQueueProtocol) -> None
A UDP connection interface.
|
| |
- Method resolution order:
- 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:
- __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 process_datagram(self, data: bytes, addr: tuple[str, int]) -> bool
- Process a datagram.
- 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 defined here:
- 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 defined here:
- __abstractmethods__ = frozenset({'process_datagram'})
- __annotations__ = {'latest_rx_address': typing.Optional[tuple[str, int]]}
- 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.
- init(self) -> None
- Initialize this instance.
- 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_binary(self, data: bytes) -> bool
- Process a binary frame.
- 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.
| |