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`.`endpoints`.`UNIXClientEndpoint``

class documentation

`class UNIXClientEndpoint: (source)`

Constructor: `UNIXClientEndpoint(reactor, path, timeout, checkPID)`

Implements interfaces: `twisted.internet.interfaces.IStreamClientEndpoint`

View In Hierarchy

UnixSocket client endpoint.

Method | `__init__` | No summary
Method | `connect` | Implement `IStreamClientEndpoint.connect` to connect via a UNIX Socket
Instance Variable | `_checkPID` | Undocumented
Instance Variable | `_path` | Undocumented
Instance Variable | `_reactor` | Undocumented
Instance Variable | `_timeout` | Undocumented

def __init__(self, reactor, path, timeout=30, checkPID=0): (source)

Parameters
reactor | An `IReactorUNIX` provider.
path:str | The path to the Unix socket file, used when connecting
timeout:int | Number of seconds to wait before assuming the connection has failed.
checkPID:bool | If True, check for a pid file to verify that a server is listening.

def connect(self, protocolFactory): (source)
from `twisted.internet.interfaces.IStreamClientEndpoint`

Implement `IStreamClientEndpoint.connect` to connect via a UNIX Socket

_checkPID = (source)

Undocumented

_path = (source)

Undocumented

_reactor = (source)

Undocumented

_timeout = (source)

Undocumented