t.w.x._QueryFactory(protocol.ClientFactory) : class documentation

Part of twisted.web.xmlrpc View Source View In Hierarchy

XML-RPC Client Factory

Instance Variable	path	The path portion of the URL to which to post method calls. (type: `str`)
Instance Variable	host	The value to use for the Host HTTP header. (type: `str`)
Instance Variable	user	The username with which to authenticate with the server when making calls. (type: `str` or `NoneType`)
Instance Variable	password	The password with which to authenticate with the server when making calls. (type: `str` or `NoneType`)
Instance Variable	useDateTime	Accept datetime values as datetime.datetime objects. also passed to the underlying xmlrpclib implementation. Defaults to `False`. (type: `bool`)
Method	__init__
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 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 =

The path portion of the URL to which to post method calls. (type: str)

host =

The value to use for the Host HTTP header. (type: str)

user =

The username with which to authenticate with the server when making calls. (type: str or NoneType)

password =

The password with which to authenticate with the server when making calls. (type: str or NoneType)

useDateTime =

Accept datetime values as datetime.datetime objects. also passed to the underlying xmlrpclib implementation. Defaults to False. (type: bool)

def __init__(self, path, host, method, user=None, password=None, allowNone=False, args=(), canceller=None, useDateTime=False): (source)

Parameters	method	The name of the method to call. (type: `str`)
	allowNone	allow the use of None values in parameters. It's passed to the underlying xmlrpclib implementation. Defaults to `False`. (type: `bool` or `NoneType`)
	args	the arguments to pass to the method. (type: `tuple`)
	canceller	A 1-argument callable passed to the deferred as the canceller callback. (type: callable or `NoneType`)

def parseResponse(self, contents): (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.

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

Undocumented

API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.