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`.`internet`.`interfaces`.`IProtocol``

interface documentation

`class IProtocol(Interface): (source)`

Known subclasses: `twisted.conch.telnet.ITelnetProtocol`

Known implementations: `twisted.internet.protocol.ConsumerToProtocolAdapter`, `twisted.internet.protocol.Protocol`, `twisted.web._http2.H2Connection`

View In Hierarchy

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 | `makeConnection` | Make a connection to a transport and a server.

def connectionLost(reason: `Failure`): (source)

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(): (source)

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(data: `bytes`): (source)

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
data:`bytes` | bytes of indeterminate length

def makeConnection(transport: `ITransport`): (source)

Make a connection to a transport and a server.