Known subclasses: twisted.conch.test.test_recvline.TestInsultsClientProtocol, twisted.conch.test.test_recvline.TestInsultsServerProtocol

Implements interfaces: twisted.conch.telnet.ITelnetProtocol

Undocumented
Method __init__ Undocumented
Method makeConnection Make a connection to a transport and a server.
Method dataReceived Called whenever data is received.
Method connectionLost Called when the connection is shut down.
Method neg_TEST_COMMAND Undocumented
Method enableLocal Enable the given option locally.
Method disableLocal Disable the given option locally.
Method enableRemote Indicate whether the peer should be allowed to enable this option.
Method disableRemote Indicate that the peer has disabled this option.
def __init__(self):
Undocumented
def makeConnection(self, transport):

Make a connection to a transport and a server.

def dataReceived(self, data):

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.

Please keep in mind that you will probably need to buffer some data as partial (or multiple) protocol messages may be received! We recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.

Parametersdatabytes of indeterminate length (type: bytes)
def connectionLost(self, reason):

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed. The reason Failure wraps a twisted.internet.error.ConnectionDone or twisted.internet.error.ConnectionLost instance (or a subclass of one of those).

def neg_TEST_COMMAND(self, payload):
Undocumented
def enableLocal(self, option):

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: bytes, a single character.)
def disableLocal(self, option):

Disable the given option locally.

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

Parametersoptionthe option to be disabled. (type: bytes, a single character.)
def enableRemote(self, option):

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: bytes, a single character.)
def disableRemote(self, option):

Indicate that the peer has disabled this option.

Parametersoptionthe option to be disabled. (type: bytes, a single character.)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.