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`.`amp`.`IBoxSender``

interface documentation

`class IBoxSender(Interface): (source)`

Known implementations: `twisted.protocols.amp.BinaryBoxProtocol`

View In Hierarchy

A transport which can send `AmpBox` objects.

Method | `sendBox` | Send an `AmpBox`.
Method | `unhandledError` | An unhandled error occurred in response to a box. Log it appropriately.

def sendBox(box): (source)

Send an `AmpBox`.

Raises
`ProtocolSwitched` | if the underlying protocol has been switched.
`ConnectionLost` | if the underlying connection has already been lost.

def unhandledError(failure): (source)

An unhandled error occurred in response to a box. Log it appropriately.

Parameters
failure | a `Failure` describing the error that occurred.