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`.`protocols`.`basic`.`Int8StringReceiver``

class documentation

`class Int8StringReceiver(IntNStringReceiver): (source)`

View In Hierarchy

A receiver for int8-prefixed strings.

An int8 string is a string prefixed by 1 byte, the 8-bit length of the string.

This class publishes the same interface as NetstringReceiver.

Class Variable | `prefixLength` | Undocumented
Class Variable | `structFormat` | Undocumented

Inherited from `IntNStringReceiver`:

Method | `dataReceived` | Convert int prefixed strings into calls to stringReceived.
Method | `lengthLimitExceeded` | Callback invoked when a length prefix greater than `MAX_LENGTH` is received. The default implementation disconnects the transport. Override this.
Method | `sendString` | Send a prefixed string to the other end of the connection.
Method | `stringReceived` | Override this for notification when each complete string is received.
Constant | `MAX_LENGTH` | Undocumented
Class Variable | `recvd` | Undocumented
Instance Variable | `_compatibilityOffset` | the offset within `_unprocessed` to the next message to be parsed. (used to generate the recvd attribute)
Instance Variable | `_unprocessed` | bytes received, but not yet broken up into messages / sent to stringReceived. _compatibilityOffset must be updated when this value is updated so that the `recvd` attribute can be generated correctly.

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

Method | `connectionLost` | Called when the connection is shut down.
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 `IntNStringReceiver`, `Protocol`):

Method | `connectionMade` | Called when a connection is made.
Method | `makeConnection` | Make a connection to a transport and a server.
Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

Inherited from `_PauseableMixin` (via `IntNStringReceiver`, `Protocol`, `BaseProtocol`):

Method | `pauseProducing` | Undocumented
Method | `resumeProducing` | Undocumented
Method | `stopProducing` | Undocumented
Instance Variable | `paused` | Undocumented

prefixLength = (source)
overrides `twisted.protocols.basic.IntNStringReceiver.prefixLength`

Undocumented

structFormat: `str` = (source)
overrides `twisted.protocols.basic.IntNStringReceiver.structFormat`

Undocumented