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

class documentation

`class TCP4ClientEndpoint: (source)`

Constructor: `TCP4ClientEndpoint(reactor, host, port, timeout, bindAddress)`

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

View In Hierarchy

TCP client endpoint with an IPv4 configuration.

Method | `__init__` | No summary
Method | `connect` | Implement `IStreamClientEndpoint.connect` to connect via TCP.
Instance Variable | `_bindAddress` | Undocumented
Instance Variable | `_host` | Undocumented
Instance Variable | `_port` | Undocumented
Instance Variable | `_reactor` | Undocumented
Instance Variable | `_timeout` | Undocumented

def __init__(self, reactor, host, port, timeout=30, bindAddress=None): (source)

Parameters
reactor | An `IReactorTCP` provider
host:str | A hostname, used when connecting
port:int | The port number, used when connecting
timeout:`float` or `int` | The number of seconds to wait before assuming the connection has failed.
bindAddress:tuple | A (host, port) tuple of local address to bind to, or None.

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

Implement `IStreamClientEndpoint.connect` to connect via TCP.

_bindAddress = (source)

Undocumented

_host = (source)

Undocumented

_port = (source)

Undocumented

_reactor = (source)

Undocumented

_timeout = (source)

Undocumented