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`.`ITerminalProtocol``

interface documentation

`class ITerminalProtocol(Interface): (source)`

Known implementations: `twisted.conch.insults.insults.TerminalProtocol`

View In Hierarchy

Undocumented

Method | `connectionLost` | Called when the connection has been lost.
Method | `keystrokeReceived` | A keystroke was received.
Method | `makeConnection` | Called with an `ITerminalTransport` when a connection is established.
Method | `terminalSize` | Called to indicate the size of the terminal.
Method | `unhandledControlSequence` | Called when an unsupported control sequence is received.

def connectionLost(reason): (source)

Called when the connection has been lost.

reason is a Failure describing why.

def keystrokeReceived(keyID, modifier): (source)

A keystroke was received.

Each keystroke corresponds to one invocation of this method. keyID is a string identifier for that key. Printable characters are represented by themselves. Control keys, such as arrows and function keys, are represented with symbolic constants on `ServerProtocol`.

def makeConnection(transport): (source)

Called with an `ITerminalTransport` when a connection is established.

def terminalSize(width, height): (source)

Called to indicate the size of the terminal.

A terminal of 80x24 should be assumed if this method is not called. This method might not be called for real terminals.

def unhandledControlSequence(seq): (source)

Called when an unsupported control sequence is received.

Parameters
seq:`str` | The whole control sequence which could not be interpreted.