twisted.conch.telnet.Telnet(protocol.Protocol) class documentation

Part of twisted.conch.telnet (View In Hierarchy)

Known subclasses: twisted.conch.telnet.TelnetTransport, twisted.conch.test.test_telnet.TestTelnet

Instance Variable commandMap A mapping of bytes to callables. When a telnet command is received, the command byte (the first byte after IAC) is looked up in this dictionary. If a callable is found, it is invoked with the argument of the command, or None if the command takes no argument. Values should be added to this dictionary if commands wish to be handled. By default, only WILL, WONT, DO, and DONT are handled. These should not be overridden, as this class handles them correctly and provides an API for interacting with them.
Instance Variable negotiationMap A mapping of bytes to callables. When a subnegotiation command is received, the command byte (the first byte after SB) is looked up in this dictionary. If a callable is found, it is invoked with the argument of the subnegotiation. Values should be added to this dictionary if subnegotiations are to be handled. By default, no values are handled.
Instance Variable options A mapping of option bytes to their current state. This state is likely of little use to user code. Changes should not be made to it.
Instance Variable state A string indicating the current parse state. It can take on the values "data", "escaped", "command", "newline", "subnegotiation", and "subnegotiation-escaped". Changes should not be made to it.
Instance Variable transport This protocol's transport object.
Method __init__ Undocumented
Method getOptionState Undocumented
Method will Indicate our willingness to enable an option.
Method wont Indicate we are not willing to enable an option.
Method do Undocumented
Method dont Undocumented
Method requestNegotiation Send a negotiation message for the option about with data as the payload.
Method dataReceived Called whenever data is received.
Method connectionLost Called when the connection is shut down.
Method applicationDataReceived Called with application-level data.
Method unhandledCommand Called for commands for which no handler is installed.
Method commandReceived Undocumented
Method unhandledSubnegotiation Called for subnegotiations for which no handler is installed.
Method negotiate Undocumented
Method telnet_WILL Undocumented
Method will_no_false Undocumented
Method will_no_true Undocumented
Method will_yes_false Undocumented
Method will_yes_true Undocumented
Method telnet_WONT Undocumented
Method wont_no_false Undocumented
Method wont_no_true Undocumented
Method wont_yes_false Undocumented
Method wont_yes_true Undocumented
Method telnet_DO Undocumented
Method do_no_false Undocumented
Method do_no_true Undocumented
Method do_yes_false Undocumented
Method do_yes_true Undocumented
Method telnet_DONT Undocumented
Method dont_no_false Undocumented
Method dont_no_true Undocumented
Method dont_yes_false Undocumented
Method dont_yes_true Undocumented
Method enableLocal Reject all attempts to enable options.
Method enableRemote Reject all attempts to enable options.
Method disableLocal Signal a programming error by raising an exception.
Method disableRemote Signal a programming error by raising an exception.
Method _write Undocumented
Class _OptionState Represents the state of an option on both sides of a telnet connection.
Method _do Undocumented
Method _dont Undocumented
Method _will Undocumented
Method _wont Undocumented

Inherited from Protocol:

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via Protocol):

Method makeConnection Make a connection to a transport and a server.
Method connectionMade Called when a connection is made.
commandMap =
A mapping of bytes to callables. When a telnet command is received, the command byte (the first byte after IAC) is looked up in this dictionary. If a callable is found, it is invoked with the argument of the command, or None if the command takes no argument. Values should be added to this dictionary if commands wish to be handled. By default, only WILL, WONT, DO, and DONT are handled. These should not be overridden, as this class handles them correctly and provides an API for interacting with them.
negotiationMap =
A mapping of bytes to callables. When a subnegotiation command is received, the command byte (the first byte after SB) is looked up in this dictionary. If a callable is found, it is invoked with the argument of the subnegotiation. Values should be added to this dictionary if subnegotiations are to be handled. By default, no values are handled.
options =
A mapping of option bytes to their current state. This state is likely of little use to user code. Changes should not be made to it.
state =
A string indicating the current parse state. It can take on the values "data", "escaped", "command", "newline", "subnegotiation", and "subnegotiation-escaped". Changes should not be made to it.
transport =
This protocol's transport object.
def __init__(self):
overridden in twisted.conch.telnet.TelnetTransport, twisted.conch.test.test_telnet.TestTelnet
Undocumented
def _write(self, data):
Undocumented
def getOptionState(self, opt):
Undocumented
def _do(self, option):
Undocumented
def _dont(self, option):
Undocumented
def _will(self, option):
Undocumented
def _wont(self, option):
Undocumented
def will(self, option):

Indicate our willingness to enable an option.

def wont(self, option):

Indicate we are not willing to enable an option.

def do(self, option):
Undocumented
def dont(self, option):
Undocumented
def requestNegotiation(self, about, data):

Send a negotiation message for the option about with data as the payload.

Parametersdatathe payload (type: bytes)
See AlsoITelnetTransport.requestNegotiation
def dataReceived(self, data):
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.dataReceived

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

Parametersdataa string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.
def connectionLost(self, reason):
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.connectionLost
overridden in twisted.conch.telnet.TelnetTransport

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

def applicationDataReceived(self, data):
overridden in twisted.conch.telnet.TelnetTransport, twisted.conch.test.test_telnet.TestTelnet

Called with application-level data.

def unhandledCommand(self, command, argument):
overridden in twisted.conch.telnet.TelnetTransport, twisted.conch.test.test_telnet.TestTelnet

Called for commands for which no handler is installed.

def commandReceived(self, command, argument):
Undocumented
def unhandledSubnegotiation(self, command, data):
overridden in twisted.conch.telnet.TelnetTransport, twisted.conch.test.test_telnet.TestTelnet

Called for subnegotiations for which no handler is installed.

def negotiate(self, data):
Undocumented
def telnet_WILL(self, option):
Undocumented
def will_no_false(self, state, option):
Undocumented
def will_no_true(self, state, option):
Undocumented
def will_yes_false(self, state, option):
Undocumented
def will_yes_true(self, state, option):
Undocumented
def telnet_WONT(self, option):
Undocumented
def wont_no_false(self, state, option):
Undocumented
def wont_no_true(self, state, option):
Undocumented
def wont_yes_false(self, state, option):
Undocumented
def wont_yes_true(self, state, option):
Undocumented
def telnet_DO(self, option):
Undocumented
def do_no_false(self, state, option):
Undocumented
def do_no_true(self, state, option):
Undocumented
def do_yes_false(self, state, option):
Undocumented
def do_yes_true(self, state, option):
Undocumented
def telnet_DONT(self, option):
Undocumented
def dont_no_false(self, state, option):
Undocumented
def dont_no_true(self, state, option):
Undocumented
def dont_yes_false(self, state, option):
Undocumented
def dont_yes_true(self, state, option):
Undocumented
def enableLocal(self, option):
overridden in twisted.conch.telnet.TelnetTransport

Reject all attempts to enable options.

def enableRemote(self, option):
overridden in twisted.conch.telnet.TelnetTransport

Reject all attempts to enable options.

def disableLocal(self, option):
overridden in twisted.conch.telnet.TelnetTransport

Signal a programming error by raising an exception.

enableLocal must return true for the given value of option in order for this method to be called. If a subclass of Telnet overrides enableLocal to allow certain options to be enabled, it must also override disableLocal to disable those options.

RaisesNotImplementedErrorAlways raised.
def disableRemote(self, option):
overridden in twisted.conch.telnet.TelnetTransport

Signal a programming error by raising an exception.

enableRemote must return true for the given value of option in order for this method to be called. If a subclass of Telnet overrides enableRemote to allow certain options to be enabled, it must also override disableRemote tto disable those options.

RaisesNotImplementedErrorAlways raised.
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.