twisted.conch.telnet.TelnetBootstrapProtocol

class documentation

class TelnetBootstrapProtocol(TelnetProtocol, ProtocolTransportMixin): (source)

Constructor: TelnetBootstrapProtocol(protocolFactory, *args, **kw)

Undocumented

Method	`__init__`	Undocumented
Method	`connectionLost`	Called when the connection is shut down.
Method	`connectionMade`	Called when a connection is made.
Method	`dataReceived`	Called whenever data is received.
Method	`enableLocal`	Enable the given option locally.
Method	`enableRemote`	Indicate whether the peer should be allowed to enable this option.
Method	`linemode_SLC`	Undocumented
Method	`telnet_LINEMODE`	Undocumented
Method	`telnet_NAWS`	Undocumented
Class Variable	`linemodeSubcommands`	Undocumented
Instance Variable	`protocol`	Undocumented
Instance Variable	`protocolArgs`	Undocumented
Instance Variable	`protocolFactory`	Undocumented
Instance Variable	`protocolKwArgs`	Undocumented

Inherited from TelnetProtocol:

Method	`disableLocal`	Disable the given option locally.
Method	`disableRemote`	Indicate that the peer has disabled this option.
Method	`unhandledCommand`	A command was received but not understood.
Method	`unhandledSubnegotiation`	A subnegotiation command was received but not understood.
Class Variable	`_log`	Undocumented

Inherited from Protocol (via TelnetProtocol):

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

Inherited from BaseProtocol (via TelnetProtocol, Protocol):

Method	`makeConnection`	Make a connection to a transport and a server.
Instance Variable	`connected`	Undocumented
Instance Variable	`transport`	Undocumented

Inherited from ProtocolTransportMixin (via TelnetProtocol, Protocol, BaseProtocol):

Method	`getHost`	Undocumented
Method	`getPeer`	Undocumented
Method	`loseConnection`	Undocumented
Method	`write`	Undocumented
Method	`writeSequence`	Undocumented

def __init__(self, protocolFactory, *args, **kw): (source) ¶

Undocumented

def connectionLost(self, reason): (source) ¶

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

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:`twisted.python.failure.Failure`	Undocumented

def connectionMade(self): (source) ¶

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.BaseProtocol.connectionMade

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

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.

def enableLocal(self, opt): (source) ¶

from twisted.conch.telnet.ITelnetProtocol

overrides twisted.conch.telnet.TelnetProtocol.enableLocal

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.