client_base

Module provides class BaseClient.

class BaseClient(shell=None, log=None, loop=None, encoding='utf8', encoding_errors='strict', force_binary=False, connect_minwait=1.0, connect_maxwait=4.0, limit=None, waiter_closed=None, _waiter_connected=None)

Base Telnet Client Protocol.

Class initializer.

default_encoding

encoding for new connections

connect_minwait

minimum duration for check_negotiation().

connect_maxwait

maximum duration for check_negotiation().

eof_received()

Called when the other end calls write_eof() or equivalent.

connection_lost(exc)

Called when the connection is lost or closed.

Parameters

exc (Exception) – exception. None indicates a closing EOF sent by this end.

connection_made(transport)

Called when a connection is made.

Ensure super().connection_made(transport) is called when derived.

data_received(data)

Process bytes received by transport.

property duration

Time elapsed since client connected, in seconds as float.

property idle

Time elapsed since data last received, in seconds as float.

get_extra_info(name, default=None)

Get optional client protocol or transport information.

begin_negotiation()

Begin on-connect negotiation.

A Telnet client is expected to send only a minimal amount of client session options immediately after connection, it is generally the server which dictates server option support.

Deriving implementations should always call super().begin_negotiation().

encoding(outgoing=False, incoming=False)

Encoding that should be used for the direction indicated.

The base implementation always returns encoding argument given to class initializer or, when unset (None), US-ASCII.

check_negotiation(final=False)

Callback, return whether negotiation is complete.

Parameters

final (bool) – Whether this is the final time this callback will be requested to answer regarding protocol negotiation.

Returns

Whether negotiation is over (client end is satisfied).

Return type

bool

Method is called on each new command byte processed until negotiation is considered final, or after connect_maxwait has elapsed, setting the _waiter_connected attribute to value self when complete.

This method returns False until connect_minwait has elapsed, ensuring the server may batch telnet negotiation demands without prematurely entering the callback shell.

Ensure super().check_negotiation() is called and conditionally combined when derived.