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`.`names`.`client`.`DNSClientFactory``

class documentation

`class DNSClientFactory(protocol.ClientFactory): (source)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `buildProtocol` | Create an instance of a subclass of Protocol.
Method | `clientConnectionFailed` | Fail all pending TCP DNS queries if the TCP connection attempt fails.
Method | `clientConnectionLost` | Called when an established connection is lost.
Instance Variable | `controller` | Undocumented
Instance Variable | `timeout` | Undocumented

Inherited from `ClientFactory`:

Method | `startedConnecting` | Called when a connection has been started.

Inherited from `Factory` (via `ClientFactory`):

Class Method | `forProtocol` | Create a factory for the given protocol.
Method | `doStart` | Make sure startFactory is called.
Method | `doStop` | Make sure stopFactory is called.
Method | `logPrefix` | Describe this factory for log messages.
Method | `startFactory` | This will be called before I begin listening on a Port or Connector.
Method | `stopFactory` | This will be called before I stop listening on all Ports/Connectors.
Class Variable | `noisy` | Undocumented
Class Variable | `protocol` | Undocumented
Instance Variable | `numPorts` | Undocumented

def __init__(self, controller, timeout=10): (source)

Undocumented

def buildProtocol(self, addr): (source)
from `twisted.internet.interfaces.IProtocolFactory`
overrides `twisted.internet.protocol.Factory.buildProtocol`

Create an instance of a subclass of Protocol.

The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory.

Alternatively, `None` may be returned to immediately close the new connection.

Override this method to alter how Protocol instances get created.

Parameters
addr | an object implementing `IAddress`

def clientConnectionFailed(self, connector, reason): (source)
overrides `twisted.internet.protocol.ClientFactory.clientConnectionFailed`

Fail all pending TCP DNS queries if the TCP connection attempt fails.

Parameters
connector:`twisted.internet.interfaces.IConnector` | Not used.
reason:`twisted.python.failure.Failure` | A `Failure` containing information about the cause of the connection failure. This will be passed as the argument to `errback` on every pending TCP query `deferred`.
See Also
`twisted.internet.protocol.ClientFactory`

def clientConnectionLost(self, connector, reason): (source)
overrides `twisted.internet.protocol.ClientFactory.clientConnectionLost`

Called when an established connection is lost.

It may be useful to call connector.connect() - this will reconnect.

Parameters
connector | Undocumented
reason:`twisted.python.failure.Failure` | Undocumented

controller = (source)

Undocumented

timeout = (source)

Undocumented