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
pathUndocumented
hostUndocumented
method:strThe name of the method to call.
userUndocumented
passwordUndocumented
allowNone:bool or Noneallow the use of None values in parameters. It's passed to the underlying xmlrpclib implementation. Defaults to False.
args:tuplethe arguments to pass to the method.
canceller:callable or NoneA 1-argument callable passed to the deferred as the canceller callback.
useDateTimeUndocumented
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.FailureUndocumented
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.