t.c.t.TelnetProtocol(protocol.Protocol) : class documentation

Part of twisted.conch.telnet View Source View In Hierarchy

Known subclasses: twisted.conch.telnet.StatefulTelnetProtocol, twisted.conch.telnet.TelnetBootstrapProtocol

Implements interfaces: twisted.conch.telnet.ITelnetProtocol

Undocumented
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.

Inherited from Protocol:

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):

Method makeConnection Make a connection to a transport and a server.
Method connectionMade Called when a connection is made.
def unhandledCommand(self, command, argument): (source)
A command was received but not understood.
Parameterscommandthe command received. (type: str, a single character.)
argumentthe 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, bytes): (source)
A subnegotiation command was received but not understood.
Parameterscommandthe command being subnegotiated. That is, the first byte after the SB command. (type: str, a single character.)
bytesall other bytes of the subneogation. That is, all but the first bytes between SB and SE, with IAC un-escaping applied. (type: list of str, each a single character)
def enableLocal(self, option): (source)
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.

Parametersoptionthe option to be enabled. (type: str, a single character.)
def enableRemote(self, option): (source)
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.

Parametersoptionthe option to be enabled. (type: str, a single character.)
def disableLocal(self, option): (source)
Disable the given option locally.

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

Parametersoptionthe option to be disabled. (type: str, a single character.)
def disableRemote(self, option): (source)
Indicate that the peer has disabled this option.
Parametersoptionthe option to be disabled. (type: str, a single character.)
API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.