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`.`web`.`xmlrpc`.`QueryFactory``

class documentation

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

Constructor: `QueryFactory(path, host, method, user, ...)`

View In Hierarchy

XML-RPC Client Factory

Method | `__init__` | No summary
Method | `badStatus` | Undocumented
Method | `clientConnectionLost` | Called when an established connection is lost.
Method | `parseResponse` | Undocumented
Instance Variable | `deferred` | Undocumented
Instance Variable | `host` | The value to use for the Host HTTP header.
Instance Variable | `password` | The password with which to authenticate with the server when making calls.
Instance Variable | `path` | The path portion of the URL to which to post method calls.
Instance Variable | `payload` | Undocumented
Instance Variable | `useDateTime` | Accept datetime values as datetime.datetime objects. also passed to the underlying xmlrpclib implementation. Defaults to `False`.
Instance Variable | `user` | The username with which to authenticate with the server when making calls.

Inherited from `ClientFactory`:

Method | `clientConnectionFailed` | Called when a connection has failed to connect.
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 | `buildProtocol` | Create an instance of a subclass of 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, path, host, method, user=None, password=None, allowNone=False, args=(), canceller=None, useDateTime=False): (source)

Parameters
path | Undocumented
host | Undocumented
method:`str` | The name of the method to call.
user | Undocumented
password | Undocumented
allowNone:`bool` or `None` | allow the use of None values in parameters. It's passed to the underlying xmlrpclib implementation. Defaults to `False`.
args:`tuple` | the arguments to pass to the method.
canceller:callable or `None` | A 1-argument callable passed to the deferred as the canceller callback.
useDateTime | Undocumented

def badStatus(self, status, message): (source)

Undocumented

def clientConnectionLost(self, _, 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
_ | Undocumented
reason:`twisted.python.failure.Failure` | Undocumented

def parseResponse(self, contents): (source)

Undocumented

deferred = (source)

Undocumented

host: `bytes` = (source)

The value to use for the Host HTTP header.

password: `bytes` or `None` = (source)

The password with which to authenticate with the server when making calls.

path: `bytes` = (source)

The path portion of the URL to which to post method calls.

payload = (source)

Undocumented

useDateTime: `bool` = (source)

Accept datetime values as datetime.datetime objects. also passed to the underlying xmlrpclib implementation. Defaults to `False`.

user: `bytes` or `None` = (source)

The username with which to authenticate with the server when making calls.