server_base¶
Module provides class BaseServer.
-
class
BaseServer
(shell=None, log=None, loop=None, _waiter_connected=None, _waiter_closed=None, encoding='utf8', encoding_errors='strict', force_binary=False, connect_maxwait=4.0, limit=None)[source]¶ Base Telnet Server Protocol.
Class initializer.
-
connect_maxwait
¶ maximum duration for
check_negotiation()
.
-
eof_received
()[source]¶ Called when the other end calls write_eof() or equivalent.
This callback may be exercised by the nc(1) client argument
-z
.
-
connection_made
(transport)[source]¶ Called when a connection is made.
Sets attributes
_transport
,_when_connected
,_last_received
,reader
andwriter
.Ensure
super().connection_made(transport)
is called when derived.
-
property
duration
¶ Time elapsed since client connected, in seconds as float.
-
property
idle
¶ Time elapsed since data last received, in seconds as float.
-
begin_negotiation
()[source]¶ Begin on-connect negotiation.
A Telnet server is expected to demand preferred session options immediately after connection. Deriving implementations should always call
super().begin_negotiation()
.
-
begin_advanced_negotiation
()[source]¶ Begin advanced negotiation.
Callback method further requests advanced telnet options. Called once on receipt of any
DO
orWILL
acknowledgments received, indicating that the remote end is capable of negotiating further.Only called if sub-classing
begin_negotiation()
causes at least one negotiation option to be affirmatively acknowledged.
-
encoding
(outgoing=False, incoming=False)[source]¶ Encoding that should be used for the direction indicated.
The base implementation always returns the encoding given to class initializer, or, when unset (None),
US-ASCII
.
-
negotiation_should_advance
()[source]¶ Whether advanced negotiation should commence.
- Return type
- Returns
True if advanced negotiation should be permitted.
The base implementation returns True if any negotiation options were affirmatively acknowledged by client, more than likely options requested in callback
begin_negotiation()
.
-
check_negotiation
(final=False)[source]¶ 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 (server end is satisfied).
- Return type
Method is called on each new command byte processed until negotiation is considered final, or after
connect_maxwait
has elapsed, setting attribute_waiter_connected
to valueself
when complete.Ensure
super().check_negotiation()
is called and conditionally combined when derived.
-