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

interface documentation

`class IStreamClientEndpointStringParserWithReactor(Interface): (source)`

Known implementations: `twisted.internet.endpoints._TLSClientEndpointParser`

View In Hierarchy

An `IStreamClientEndpointStringParserWithReactor` is a parser which can convert a set of string `*args` and `**kwargs` into an `IStreamClientEndpoint` provider.

This interface is really only useful in the context of the plugin system for `endpoints.clientFromString`. See the document entitled "The Twisted Plugin System" for more details on how to write a plugin.

If you place an `IStreamClientEndpointStringParserWithReactor` plugin in the `twisted.plugins` package, that plugin's `parseStreamClient` method will be used to produce endpoints for any description string that begins with the result of that `IStreamClientEndpointStringParserWithReactor`'s prefix attribute.

Method | `parseStreamClient` | This method is invoked by `endpoints.clientFromString`, if the type of endpoint matches the return value from this `IStreamClientEndpointStringParserWithReactor`'s `prefix` method.
Attribute | `prefix` | `bytes`, the description prefix to respond to. For example, an `IStreamClientEndpointStringParserWithReactor` plugin which had `b"foo"` for its `prefix` attribute would be called for endpoint descriptions like ...

def parseStreamClient(reactor, *args, **kwargs): (source)

This method is invoked by `endpoints.clientFromString`, if the type of endpoint matches the return value from this `IStreamClientEndpointStringParserWithReactor`'s `prefix` method.

Parameters
reactor:`IReactorCore` | The reactor passed to `endpoints.clientFromString`.
*args:`object` | The byte string arguments, minus the endpoint type, in the endpoint description string, parsed according to the rules described in `endpoints.quoteStringArgument`. For example, if the description were `b"my-type:foo:bar:baz=qux"`, `args` would be `(b'foo', b'bar')`
**kwargs:`object` | The byte string arguments from the endpoint description passed as keyword arguments. For example, if the description were `b"my-type:foo:bar:baz=qux"`, `kwargs` would be `dict(baz=b'qux')`.
Returns
`IStreamClientEndpoint` | a client endpoint

prefix = (source)

`bytes`, the description prefix to respond to. For example, an `IStreamClientEndpointStringParserWithReactor` plugin which had `b"foo"` for its `prefix` attribute would be called for endpoint descriptions like `b"foo:bar:baz"` or `b"foo:"`.