twisted.conch.telnet.TelnetProtocol : API documentation

Method	unhandledCommand	A command was received but not understood.
Method	unhandledSubnegotiation	A subnegotiation command was received but not understood.
Method	enableLocal	Enable the given option locally.
Method	enableRemote	Indicate whether the peer should be allowed to enable this option.
Method	disableLocal	Disable the given option locally.
Method	disableRemote	Indicate that the peer has disabled this option.
Class Variable	_log	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.
Method	dataReceived	Called whenever data is received.
Method	connectionLost	Called when the connection is shut down.

Inherited from BaseProtocol (via Protocol):

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

_log = (source)

Undocumented

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

from twisted.conch.telnet.ITelnetProtocol

A command was received but not understood.

Parameters	command	the command received. (type: `str`, a single character.)
	argument	the argument to the received command. (type: `str`, a single character, or None if the command that was unhandled does not provide an argument.)

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

from twisted.conch.telnet.ITelnetProtocol

A subnegotiation command was received but not understood.

Parameters	command	the command being subnegotiated. That is, the first byte after the SB command. (type: `str`, a single character.)
	data	all other bytes of the subneogation. That is, all but the first bytes between SB and SE, with IAC un-escaping applied. (type: `bytes`, each a single character)

def enableLocal(self, option): (source)

from twisted.conch.telnet.ITelnetProtocol

overridden in twisted.conch.telnet.TelnetBootstrapProtocol

Enable the given option locally.

This should enable the given option on this side of the telnet connection and return True. If False is returned, the option will be treated as still disabled and the peer will be notified.

Parameters option the option to be enabled. (type: bytes, a single character.)

def enableRemote(self, option): (source)

from twisted.conch.telnet.ITelnetProtocol

overridden in twisted.conch.telnet.TelnetBootstrapProtocol

Indicate whether the peer should be allowed to enable this option.

Returns True if the peer should be allowed to enable this option, False otherwise.

Parameters option the option to be enabled. (type: bytes, a single character.)

def disableLocal(self, option): (source)

from twisted.conch.telnet.ITelnetProtocol

Disable the given option locally.

Unlike enableLocal, this method cannot fail. The option must be disabled.

Parameters option the option to be disabled. (type: bytes, a single character.)

def disableRemote(self, option): (source)

from twisted.conch.telnet.ITelnetProtocol

Indicate that the peer has disabled this option.

Parameters option the option to be disabled. (type: bytes, a single character.)