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`.`insults`.`insults`.`ClientProtocol``

class documentation

`class ClientProtocol(protocol.Protocol): (source)`

Constructor: `ClientProtocol(terminalFactory, *a, **kw)`

View In Hierarchy

Undocumented

Class | `ControlSequenceParser` | Undocumented
Method | `__init__` | No summary
Method | `connectionLost` | Called when the connection is shut down.
Method | `connectionMade` | Called when a connection is made.
Method | `dataReceived` | Parse the given data from a terminal server, dispatching to event handlers defined by `self.terminal`.
Class Variable | `controlSequenceParser` | Undocumented
Class Variable | `factory` | Undocumented
Instance Variable | `state` | Undocumented
Instance Variable | `terminal` | Undocumented
Instance Variable | `terminalArgs` | Undocumented
Instance Variable | `terminalFactory` | Undocumented
Instance Variable | `terminalKwArgs` | Undocumented
Method | `_handleControlSequence` | Undocumented
Method | `_handleHeightWidth` | Undocumented
Class Variable | `_charsets` | Undocumented
Class Variable | `_escBuf` | Undocumented
Class Variable | `_longs` | Undocumented
Class Variable | `_shorts` | Undocumented

Inherited from `Protocol`:

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

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

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

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

Parameters
terminalFactory | A callable which will be invoked with *a, **kw and should return an ITerminalTransport provider. This will be invoked when this ClientProtocol establishes a connection.
*a | Any positional arguments to pass to terminalFactory.
**kw | Any keyword arguments to pass to terminalFactory.

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`

Parse the given data from a terminal server, dispatching to event handlers defined by `self.terminal`.

controlSequenceParser = (source)

Undocumented

factory = (source)
overrides `twisted.internet.protocol.Protocol.factory`

Undocumented

state: `bytes` = (source)

Undocumented

terminal = (source)

Undocumented

terminalArgs = (source)

Undocumented

terminalFactory = (source)

Undocumented

terminalKwArgs = (source)

Undocumented

def _handleControlSequence(self, buf, terminal): (source)

Undocumented

def _handleHeightWidth(self, b): (source)

Undocumented

_charsets = (source)

Undocumented

_escBuf = (source)

Undocumented

_longs: `dict[bytes, bytes]` = (source)

Undocumented

_shorts: `dict[bytes, bytes]` = (source)

Undocumented