Generic Endpoints

Low-level asynchronous endpoints module.

Stream Endpoints

Low-level asynchronous endpoints module for connection-oriented communication.

class easynetwork.lowlevel.api_async.endpoints.stream.AsyncStreamEndpoint

Bases: AsyncBaseTransport, Generic[_T_SentPacket, _T_ReceivedPacket]

A full-duplex communication endpoint based on continuous stream data transport.

__init__(transport: AsyncStreamTransport, protocol: StreamProtocol[_T_SentPacket, _T_ReceivedPacket] | BufferedStreamProtocol[_T_SentPacket, _T_ReceivedPacket, Any], max_recv_size: int) → None
Parameters:
is_closing() → bool

Checks if the endpoint is closed or in the process of being closed.

Returns:

True if the endpoint is closed.

Return type:

bool

async aclose() → None

Closes the endpoint.

async send_packet(packet: _T_SentPacket) → None

Sends packet to the remote endpoint.

Warning

In the case of a cancellation, it is impossible to know if all the packet data has been sent. This would leave the connection in an inconsistent state.

Parameters:

packet (_T_SentPacket) – the Python object to send.

Raises:

RuntimeError – send_eof() has been called earlier.

async send_eof() → None

Close the write end of the stream after the buffered write data is flushed.

This method does nothing if the endpoint is closed.

Can be safely called multiple times.

async recv_packet() → _T_ReceivedPacket

Waits for a new packet to arrive from the remote endpoint.

Raises:
Returns:

the received packet.

Return type:

_T_ReceivedPacket

backend() → AsyncBackend
Returns:

The backend implementation linked to this transport.

Return type:

AsyncBackend

property extra_attributes: Mapping[Any, Callable[[], Any]]

A mapping of the extra attributes to callables that return the corresponding values.

If the provider wraps another provider, the attributes from that wrapper should also be included in the returned mapping (but the wrapper may override the callables from the wrapped instance).

The callables should raise TypedAttributeLookupError if it is not possible to get the value.

class easynetwork.lowlevel.api_async.endpoints.stream.AsyncStreamReceiverEndpoint

Bases: AsyncBaseTransport, Generic[_T_ReceivedPacket]

A read-only communication endpoint based on continuous stream data transport.

__init__(transport: AsyncStreamReadTransport, protocol: StreamProtocol[Any, _T_ReceivedPacket] | BufferedStreamProtocol[Any, _T_ReceivedPacket, Any], max_recv_size: int) → None
Parameters:
is_closing() → bool

Checks if the endpoint is closed or in the process of being closed.

Returns:

True if the endpoint is closed.

Return type:

bool

async aclose() → None

Closes the endpoint.

async recv_packet() → _T_ReceivedPacket

Waits for a new packet to arrive from the remote endpoint.

Raises:
Returns:

the received packet.

Return type:

_T_ReceivedPacket

backend() → AsyncBackend
Returns:

The backend implementation linked to this transport.

Return type:

AsyncBackend

property extra_attributes: Mapping[Any, Callable[[], Any]]

A mapping of the extra attributes to callables that return the corresponding values.

If the provider wraps another provider, the attributes from that wrapper should also be included in the returned mapping (but the wrapper may override the callables from the wrapped instance).

The callables should raise TypedAttributeLookupError if it is not possible to get the value.

class easynetwork.lowlevel.api_async.endpoints.stream.AsyncStreamSenderEndpoint

Bases: AsyncBaseTransport, Generic[_T_SentPacket]

A write-only communication endpoint based on continuous stream data transport.

__init__(transport: AsyncStreamWriteTransport, protocol: StreamProtocol[_T_SentPacket, Any] | BufferedStreamProtocol[_T_SentPacket, Any, Any]) → None
Parameters:
is_closing() → bool

Checks if the endpoint is closed or in the process of being closed.

Returns:

True if the endpoint is closed.

Return type:

bool

async aclose() → None

Closes the endpoint.

async send_packet(packet: _T_SentPacket) → None

Sends packet to the remote endpoint.

Warning

In the case of a cancellation, it is impossible to know if all the packet data has been sent. This would leave the connection in an inconsistent state.

Parameters:

packet (_T_SentPacket) – the Python object to send.

backend() → AsyncBackend
Returns:

The backend implementation linked to this transport.

Return type:

AsyncBackend

property extra_attributes: Mapping[Any, Callable[[], Any]]

A mapping of the extra attributes to callables that return the corresponding values.

If the provider wraps another provider, the attributes from that wrapper should also be included in the returned mapping (but the wrapper may override the callables from the wrapped instance).

The callables should raise TypedAttributeLookupError if it is not possible to get the value.

Datagram Endpoints

Low-level asynchronous endpoints module for datagram-based communication.

class easynetwork.lowlevel.api_async.endpoints.datagram.AsyncDatagramEndpoint

Bases: AsyncBaseTransport, Generic[_T_SentPacket, _T_ReceivedPacket]

A full-duplex communication endpoint based on unreliable packets of data.

__init__(transport: AsyncDatagramTransport, protocol: DatagramProtocol[_T_SentPacket, _T_ReceivedPacket]) → None
Parameters:
is_closing() → bool

Checks if the endpoint is closed or in the process of being closed.

Returns:

True if the endpoint is closed.

Return type:

bool

async aclose() → None

Closes the endpoint.

async send_packet(packet: _T_SentPacket) → None

Sends packet to the remote endpoint.

Warning

In the case of a cancellation, it is impossible to know if all the packet data has been sent.

Parameters:

packet (_T_SentPacket) – the Python object to send.

async recv_packet() → _T_ReceivedPacket

Waits for a new packet from the remote endpoint.

Raises:

DatagramProtocolParseError – invalid data received.

Returns:

the received packet.

Return type:

_T_ReceivedPacket

backend() → AsyncBackend
Returns:

The backend implementation linked to this transport.

Return type:

AsyncBackend

property extra_attributes: Mapping[Any, Callable[[], Any]]

A mapping of the extra attributes to callables that return the corresponding values.

If the provider wraps another provider, the attributes from that wrapper should also be included in the returned mapping (but the wrapper may override the callables from the wrapped instance).

The callables should raise TypedAttributeLookupError if it is not possible to get the value.

class easynetwork.lowlevel.api_async.endpoints.datagram.AsyncDatagramReceiverEndpoint

Bases: AsyncBaseTransport, Generic[_T_ReceivedPacket]

A read-only communication endpoint based on unreliable packets of data.

__init__(transport: AsyncDatagramReadTransport, protocol: DatagramProtocol[Any, _T_ReceivedPacket]) → None
Parameters:
is_closing() → bool

Checks if the endpoint is closed or in the process of being closed.

Returns:

True if the endpoint is closed.

Return type:

bool

async aclose() → None

Closes the endpoint.

async recv_packet() → _T_ReceivedPacket

Waits for a new packet from the remote endpoint.

Raises:

DatagramProtocolParseError – invalid data received.

Returns:

the received packet.

Return type:

_T_ReceivedPacket

backend() → AsyncBackend
Returns:

The backend implementation linked to this transport.

Return type:

AsyncBackend

property extra_attributes: Mapping[Any, Callable[[], Any]]

A mapping of the extra attributes to callables that return the corresponding values.

If the provider wraps another provider, the attributes from that wrapper should also be included in the returned mapping (but the wrapper may override the callables from the wrapped instance).

The callables should raise TypedAttributeLookupError if it is not possible to get the value.

class easynetwork.lowlevel.api_async.endpoints.datagram.AsyncDatagramSenderEndpoint

Bases: AsyncBaseTransport, Generic[_T_SentPacket]

A write-only communication endpoint based on unreliable packets of data.

__init__(transport: AsyncDatagramWriteTransport, protocol: DatagramProtocol[_T_SentPacket, Any]) → None
Parameters:
is_closing() → bool

Checks if the endpoint is closed or in the process of being closed.

Returns:

True if the endpoint is closed.

Return type:

bool

async aclose() → None

Closes the endpoint.

async send_packet(packet: _T_SentPacket) → None

Sends packet to the remote endpoint.

Warning

In the case of a cancellation, it is impossible to know if all the packet data has been sent.

Parameters:

packet (_T_SentPacket) – the Python object to send.

backend() → AsyncBackend
Returns:

The backend implementation linked to this transport.

Return type:

AsyncBackend

property extra_attributes: Mapping[Any, Callable[[], Any]]

A mapping of the extra attributes to callables that return the corresponding values.

If the provider wraps another provider, the attributes from that wrapper should also be included in the returned mapping (but the wrapper may override the callables from the wrapped instance).

The callables should raise TypedAttributeLookupError if it is not possible to get the value.