twisted.conch.telnet.Telnet : API documentation

class documentation

class twisted.conch.telnet.Telnet(protocol.Protocol): (source)

Known subclasses: twisted.conch.telnet.TelnetTransport

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.
Instance Variable	commands	Undocumented
Instance Variable	command	Undocumented
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
Class Variable	willMap	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
Class Variable	wontMap	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
Class Variable	doMap	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
Class Variable	dontMap	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:

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

Inherited from BaseProtocol (via Protocol):

Instance Variable	connected	Undocumented
Method	makeConnection	Make a connection to a transport and a server.
Method	connectionMade	Called when a connection is made.

commandMap = (source)

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 = (source)

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.

(type: dict)

options = (source)

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.

(type: dict)

state = (source)

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.

(type: str)

transport = (source)

overrides twisted.internet.protocol.BaseProtocol.transport

This protocol's transport object.

def __init__(self): (source)

overridden in twisted.conch.telnet.TelnetTransport

Undocumented

def _write(self, data): (source)

Undocumented

def getOptionState(self, opt): (source)

Undocumented

def _do(self, option): (source)

Undocumented

def _dont(self, option): (source)

Undocumented

def _will(self, option): (source)

Undocumented

def _wont(self, option): (source)

Undocumented

def will(self, option): (source)

Indicate our willingness to enable an option.

def wont(self, option): (source)

Indicate we are not willing to enable an option.

def do(self, option): (source)

Undocumented

def dont(self, option): (source)

Undocumented

def requestNegotiation(self, about, data): (source)

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

Parameters	about	Undocumented
	data	the payload (type: `bytes`)
See Also	`ITelnetTransport.requestNegotiation`

def dataReceived(self, data): (source)

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.

Parameters data a 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.

commands = (source)

Undocumented

(type: list)

command = (source)

Undocumented

def connectionLost(self, reason): (source)

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.

Parameters reason Undocumented (type: twisted.python.failure.Failure)

def applicationDataReceived(self, data): (source)

overridden in twisted.conch.telnet.TelnetTransport

Called with application-level data.

def unhandledCommand(self, command, argument): (source)

overridden in twisted.conch.telnet.TelnetTransport

Called for commands for which no handler is installed.

def commandReceived(self, command, argument): (source)

Undocumented

def unhandledSubnegotiation(self, command, data): (source)

overridden in twisted.conch.telnet.TelnetTransport

Called for subnegotiations for which no handler is installed.

def negotiate(self, data): (source)

Undocumented

def telnet_WILL(self, option): (source)

Undocumented

def will_no_false(self, state, option): (source)

Undocumented

def will_no_true(self, state, option): (source)

Undocumented

def will_yes_false(self, state, option): (source)

Undocumented

def will_yes_true(self, state, option): (source)

Undocumented

willMap = (source)

Undocumented

def telnet_WONT(self, option): (source)

Undocumented

def wont_no_false(self, state, option): (source)

Undocumented

def wont_no_true(self, state, option): (source)

Undocumented

def wont_yes_false(self, state, option): (source)

Undocumented

def wont_yes_true(self, state, option): (source)

Undocumented

wontMap = (source)

Undocumented

def telnet_DO(self, option): (source)

Undocumented

def do_no_false(self, state, option): (source)

Undocumented

def do_no_true(self, state, option): (source)

Undocumented

def do_yes_false(self, state, option): (source)

Undocumented

def do_yes_true(self, state, option): (source)

Undocumented

doMap = (source)

Undocumented

def telnet_DONT(self, option): (source)

Undocumented

def dont_no_false(self, state, option): (source)

Undocumented

def dont_no_true(self, state, option): (source)

Undocumented

def dont_yes_false(self, state, option): (source)

Undocumented

def dont_yes_true(self, state, option): (source)

Undocumented

dontMap = (source)

Undocumented

def enableLocal(self, option): (source)

overridden in twisted.conch.telnet.TelnetTransport

Reject all attempts to enable options.

def enableRemote(self, option): (source)

overridden in twisted.conch.telnet.TelnetTransport

Reject all attempts to enable options.

def disableLocal(self, option): (source)

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.

Raises NotImplementedError Always raised.

def disableRemote(self, option): (source)

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.

Raises NotImplementedError Always raised.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.