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`.`htb`.`FilterByServer``

class documentation

`class FilterByServer(HierarchicalBucketFilter): (source)`

View In Hierarchy

A Hierarchical Bucket filter with a `Bucket` for each service.

Method | `getBucketKey` | Construct a key based on the input parameters to choose a `Bucket`.
Class Variable | `sweepInterval` | Undocumented

Inherited from `HierarchicalBucketFilter`:

Method | `__init__` | Undocumented
Method | `getBucketFor` | Find or create a `Bucket` corresponding to the provided parameters.
Method | `sweep` | Remove empty buckets.
Class Variable | `bucketFactory` | Class of buckets to make.
Instance Variable | `buckets` | Undocumented
Instance Variable | `lastSweep` | Undocumented
Instance Variable | `parentFilter` | Undocumented

def getBucketKey(self, transport): (source)
overrides `twisted.protocols.htb.HierarchicalBucketFilter.getBucketKey`

Construct a key based on the input parameters to choose a `Bucket`.

The default implementation returns the same key for all arguments. Override this method to provide `Bucket` selection.

Returns
Something to be used as a key in the bucket cache.

sweepInterval = (source)
overrides `twisted.protocols.htb.HierarchicalBucketFilter.sweepInterval`

Undocumented