twisted.conch.telnet.TelnetTransport : API documentation

Instance Variable	protocol	An instance of the protocol to which this transport is connected, or None before the connection is established and after it is lost.
Instance Variable	protocolFactory	A callable which returns protocol instances which provide `ITelnetProtocol`. This will be invoked when a connection is established. It is passed protocolArgs and *protocolKwArgs.
Instance Variable	protocolArgs	A tuple of additional arguments to pass to protocolFactory.
Instance Variable	protocolKwArgs	A dictionary of additional arguments to pass to protocolFactory.
Method	__init__	Undocumented
Method	connectionMade	Called when a connection is made.
Method	connectionLost	Called when the connection is shut down.
Method	enableLocal	Reject all attempts to enable options.
Method	enableRemote	Reject all attempts to enable options.
Method	disableLocal	Signal a programming error by raising an exception.
Method	disableRemote	Signal a programming error by raising an exception.
Method	unhandledSubnegotiation	Called for subnegotiations for which no handler is installed.
Method	unhandledCommand	Called for commands for which no handler is installed.
Method	applicationDataReceived	Called with application-level data.
Method	write	Undocumented

Inherited from ProtocolTransportMixin:

Method	writeSequence	Undocumented
Method	loseConnection	Undocumented
Method	getHost	Undocumented
Method	getPeer	Undocumented

Inherited from ProtocolTransportMixin:

Method	writeSequence	Undocumented
Method	loseConnection	Undocumented
Method	getHost	Undocumented
Method	getPeer	Undocumented

Inherited from ProtocolTransportMixin:

Method	writeSequence	Undocumented
Method	loseConnection	Undocumented
Method	getHost	Undocumented
Method	getPeer	Undocumented

Inherited from ProtocolTransportMixin:

Method	writeSequence	Undocumented
Method	loseConnection	Undocumented
Method	getHost	Undocumented
Method	getPeer	Undocumented

protocol =

An instance of the protocol to which this transport is connected, or None before the connection is established and after it is lost.

protocolFactory =

A callable which returns protocol instances which provide ITelnetProtocol. This will be invoked when a connection is established. It is passed *protocolArgs and **protocolKwArgs.

protocolArgs =

A tuple of additional arguments to pass to protocolFactory.

protocolKwArgs =

A dictionary of additional arguments to pass to protocolFactory.

def __init__(self, *a, protocolFactory=None, **kw): (source)

overrides twisted.conch.telnet.Telnet.__init__

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 connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.conch.telnet.Telnet.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.

def enableLocal(self, option): (source)

overrides twisted.conch.telnet.Telnet.enableLocal

Reject all attempts to enable options.

def enableRemote(self, option): (source)

overrides twisted.conch.telnet.Telnet.enableRemote

Reject all attempts to enable options.

def disableLocal(self, option): (source)

overrides twisted.conch.telnet.Telnet.disableLocal

Signal a programming error by raising an exception.

enableLocal must return true for the given value of option in order for this method to be called. If a subclass of Telnet overrides enableLocal to allow certain options to be enabled, it must also override disableLocal to disable those options.

Raises NotImplementedError Always raised.

def disableRemote(self, option): (source)

overrides twisted.conch.telnet.Telnet.disableRemote

Signal a programming error by raising an exception.

enableRemote must return true for the given value of option in order for this method to be called. If a subclass of Telnet overrides enableRemote to allow certain options to be enabled, it must also override disableRemote tto disable those options.

Raises NotImplementedError Always raised.

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

overrides twisted.conch.telnet.Telnet.unhandledSubnegotiation

Called for subnegotiations for which no handler is installed.

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

overrides twisted.conch.telnet.Telnet.unhandledCommand

Called for commands for which no handler is installed.

def applicationDataReceived(self, bytes): (source)

overrides twisted.conch.telnet.Telnet.applicationDataReceived

Called with application-level data.

def write(self, data): (source)

overrides twisted.conch.telnet.ProtocolTransportMixin.write

Undocumented

twisted.conch.telnet.TelnetTransport(Telnet, ProtocolTransportMixin) class documentation

`twisted.conch.telnet.TelnetTransport(Telnet, ProtocolTransportMixin)` class documentation