twisted.conch.test.test_telnet.TestProtocol

class documentation

class TestProtocol: (source)

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

Implements interfaces: twisted.conch.telnet.ITelnetProtocol

View In Hierarchy

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 disableLocal Disable the given option locally.
Method disableRemote Indicate that the peer has disabled this option.
Method enableLocal Enable the given option locally.
Method enableRemote Indicate whether the peer should be allowed to enable this option.
Method makeConnection Make a connection to a transport and a server.
Method neg_TEST_COMMAND Undocumented
Method unhandledCommand A command was received but not understood.
Method unhandledSubnegotiation A subnegotiation command was received but not understood.
Class Variable localEnableable Undocumented
Class Variable remoteEnableable Undocumented
Instance Variable calls Undocumented
Instance Variable data Undocumented
Instance Variable disabledLocal Undocumented
Instance Variable disabledRemote Undocumented
Instance Variable enabledLocal Undocumented
Instance Variable enabledRemote Undocumented
Instance Variable subcmd Undocumented
def __init__(self): (source)

Undocumented

def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol

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 connectionMade(self): (source)
from twisted.internet.interfaces.IProtocol

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

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.

Parameters
databytes of indeterminate length
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:bytes, a single character.the option to be disabled.
def disableRemote(self, option): (source)
from twisted.conch.telnet.ITelnetProtocol

Indicate that the peer has disabled this option.

Parameters
option:bytes, a single character.the option to be disabled.
def enableLocal(self, option): (source)
from twisted.conch.telnet.ITelnetProtocol

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:bytes, a single character.the option to be enabled.
def enableRemote(self, option): (source)
from twisted.conch.telnet.ITelnetProtocol

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:bytes, a single character.the option to be enabled.
def makeConnection(self, transport): (source)
from twisted.internet.interfaces.IProtocol

Make a connection to a transport and a server.

def neg_TEST_COMMAND(self, payload): (source)

Undocumented

def unhandledCommand(self, command, argument): (source)
from twisted.conch.telnet.ITelnetProtocol

A command was received but not understood.

Parameters
command:str, a single character.the command received.
argument:str, a single character, or None if the command that was unhandled does not provide an argument.the argument to the received command.
def unhandledSubnegotiation(self, command, data): (source)
from twisted.conch.telnet.ITelnetProtocol

A subnegotiation command was received but not understood.

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

Undocumented

remoteEnableable: tuple = (source)

Undocumented

calls: list = (source)

Undocumented

data: bytes = (source)

Undocumented

disabledLocal: list = (source)

Undocumented

disabledRemote: list = (source)

Undocumented

enabledLocal: list = (source)

Undocumented

enabledRemote: list = (source)

Undocumented

subcmd = (source)

Undocumented