Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`conch`.`telnet`.`TelnetTransport``

class documentation

`class TelnetTransport(Telnet, ProtocolTransportMixin): (source)`

View In Hierarchy

Method | `__init__` | Undocumented
Method | `applicationDataReceived` | Called with application-level data.
Method | `connectionLost` | Called when the connection is shut down.
Method | `connectionMade` | Called when a connection is made.
Method | `disableLocal` | Signal a programming error by raising an exception.
Method | `disableRemote` | Signal a programming error by raising an exception.
Method | `enableLocal` | Reject all attempts to enable options.
Method | `enableRemote` | Reject all attempts to enable options.
Method | `unhandledCommand` | Called for commands for which no handler is installed.
Method | `unhandledSubnegotiation` | Called for subnegotiations for which no handler is installed.
Method | `write` | Undocumented
Class Variable | `disconnecting` | Undocumented
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 | `protocolArgs` | A tuple of additional arguments to pass to protocolFactory.
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 | `protocolKwArgs` | A dictionary of additional arguments to pass to protocolFactory.

Inherited from `Telnet`:

Method | `commandReceived` | Undocumented
Method | `dataReceived` | Called whenever data is received.
Method | `do` | Undocumented
Method | `do_no_false` | Undocumented
Method | `do_no_true` | Undocumented
Method | `do_yes_false` | Undocumented
Method | `do_yes_true` | Undocumented
Method | `dont` | Undocumented
Method | `dont_no_false` | Undocumented
Method | `dont_no_true` | Undocumented
Method | `dont_yes_false` | Undocumented
Method | `dont_yes_true` | Undocumented
Method | `getOptionState` | Undocumented
Method | `negotiate` | Undocumented
Method | `requestNegotiation` | Send a negotiation message for the option `about` with `data` as the payload.
Method | `telnet_DO` | Undocumented
Method | `telnet_DONT` | Undocumented
Method | `telnet_WILL` | Undocumented
Method | `telnet_WONT` | Undocumented
Method | `will` | Indicate our willingness to enable an option.
Method | `will_no_false` | Undocumented
Method | `will_no_true` | Undocumented
Method | `will_yes_false` | Undocumented
Method | `will_yes_true` | Undocumented
Method | `wont` | Indicate we are not willing to enable an option.
Method | `wont_no_false` | Undocumented
Method | `wont_no_true` | Undocumented
Method | `wont_yes_false` | Undocumented
Method | `wont_yes_true` | Undocumented
Class Variable | `doMap` | Undocumented
Class Variable | `dontMap` | Undocumented
Class Variable | `willMap` | Undocumented
Class Variable | `wontMap` | Undocumented
Instance Variable | `commandMap` | A mapping of bytes to callables. When a telnet command is received, the command byte (the first byte after IAC) is looked up in this dictionary. If a callable is found, it is invoked with the argument of the command, or None if the command takes no argument...
Instance Variable | `negotiationMap` | A mapping of bytes to callables. When a subnegotiation command is received, the command byte (the first byte after SB) is looked up in this dictionary. If a callable is found, it is invoked with the argument of the subnegotiation...
Instance Variable | `options` | A mapping of option bytes to their current state. This state is likely of little use to user code. Changes should not be made to it.
Instance Variable | `state` | A string indicating the current parse state. It can take on the values "data", "escaped", "command", "newline", "subnegotiation", and "subnegotiation-escaped". Changes should not be made to it.
Instance Variable | `transport` | This protocol's transport object.
Class | `_OptionState` | Represents the state of an option on both sides of a telnet connection.
Method | `_do` | Undocumented
Method | `_dont` | Undocumented
Method | `_will` | Undocumented
Method | `_wont` | Undocumented
Method | `_write` | Undocumented

Inherited from `Protocol` (via `Telnet`):

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 `Telnet`, `Protocol`):

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

Inherited from `ProtocolTransportMixin` (via `Telnet`, `Protocol`, `BaseProtocol`):

Method | `getHost` | Undocumented
Method | `getPeer` | Undocumented
Method | `loseConnection` | Undocumented
Method | `writeSequence` | Undocumented

def __init__(self, protocolFactory=None, *a, **kw): (source)
overrides `twisted.conch.telnet.Telnet.__init__`

Undocumented

def applicationDataReceived(self, data): (source)
overrides `twisted.conch.telnet.Telnet.applicationDataReceived`

Called with application-level data.

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.

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 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 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 unhandledCommand(self, command, argument): (source)
overrides `twisted.conch.telnet.Telnet.unhandledCommand`

Called for commands for which no handler is installed.

def unhandledSubnegotiation(self, command, data): (source)
overrides `twisted.conch.telnet.Telnet.unhandledSubnegotiation`

Called for subnegotiations for which no handler is installed.

def write(self, data): (source)
overrides `twisted.conch.telnet.ProtocolTransportMixin.write`

Undocumented

disconnecting: `bool` = (source)

Undocumented

protocol = (source)

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

protocolArgs = (source)

A tuple of additional arguments to pass to protocolFactory.

protocolFactory = (source)

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

protocolKwArgs = (source)

A dictionary of additional arguments to pass to protocolFactory.