class documentation

class twisted.web.xmlrpc.QueryFactory(protocol.ClientFactory): (source)

View In Hierarchy

XML-RPC Client Factory

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

Inherited from ClientFactory:

Method startedConnecting Called when a connection has been started.
Method clientConnectionFailed Called when a connection has failed to connect.

Inherited from Factory (via ClientFactory):

Class Variable protocol Undocumented
Instance Variable numPorts Undocumented
Class Variable noisy Undocumented
Class Method forProtocol Create a factory for the given protocol.
Method logPrefix Describe this factory for log messages.
Method doStart Make sure startFactory is called.
Method doStop Make sure stopFactory is called.
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.
Method buildProtocol Create an instance of a subclass of Protocol.
path = (source)
The path portion of the URL to which to post method calls.
(type: bytes)
host = (source)
The value to use for the Host HTTP header.
(type: bytes)
user = (source)
The username with which to authenticate with the server when making calls.
(type: bytes or None)
password = (source)
The password with which to authenticate with the server when making calls.
(type: bytes or None)
useDateTime = (source)
Accept datetime values as datetime.datetime objects. also passed to the underlying xmlrpclib implementation. Defaults to False.
(type: bool)
deferred = (source)

Undocumented

def __init__(self, path, host, method, user=None, password=None, allowNone=False, args=(), canceller=None, useDateTime=False): (source)
ParameterspathUndocumented
hostUndocumented
methodThe name of the method to call. (type: str)
userUndocumented
passwordUndocumented
allowNoneallow the use of None values in parameters. It's passed to the underlying xmlrpclib implementation. Defaults to False. (type: bool or None)
argsthe arguments to pass to the method. (type: tuple)
cancellerA 1-argument callable passed to the deferred as the canceller callback. (type: callable or None)
useDateTimeUndocumented
payload = (source)

Undocumented

def parseResponse(self, contents): (source)

Undocumented

def clientConnectionLost(self, _, reason): (source)

Called when an established connection is lost.

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

Parameters_Undocumented
reasonUndocumented (type: twisted.python.failure.Failure)
def badStatus(self, status, message): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.