OMQ::QorusSystemAPIHelper Class Reference

class used to call the Qorus system API for a remote Qorus instance through the network API More...

Inheritance diagram for OMQ::QorusSystemAPIHelper:

Collaboration diagram for OMQ::QorusSystemAPIHelper:

Public Member Methods
	constructor (*hash< auto > opts, *code init)
	creates the object based on the options passed
	constructor (string name)
	creates the object based on the connection information for the given remote connection
auto	methodGate (string api,...)
	transparently redirects object method calls to a remote server method call and returns the response
auto	memberGate (string api,...)
	transparently redirects object member references to a remote server method call and returns the response
Public Member Methods inherited from OMQ::QorusSystemAPIHelperBase
	constructor (*hash< auto > opts, *code init)
	creates the object based on the options passed
	copy ()
	creates a copy of the object
	setQorusAuthToken (string token)
	Sets the Qorus authentication token.
	addDefaultHeaders (hash< auto > h)
	adds default headers to each request; these headers will be sent in all requests
hash< auto >	getDefaultHeaders ()
	returns the hash of default headers to sent in all requests
	setOptions ()
	this variant of the setOptions() method does nothing when called with no argument
	setOptions (hash< auto > opts)
	sets connection options
	setURL (string url)
	sets the URL
	setProxyURL (*string url)
	sets or clears the proxy URL
string	getURL ()
	returns the current URL value
*string	getProxyURL ()
	returns the current proxy URL value or NOTHING if none is set
bool	isXmlRpc ()
	returns True if the object is using the XML-RPC protocol
bool	isJsonRpc ()
	returns True if the object is using the JSON-RPC protocol
bool	isYamlRpc ()
	returns True if the object is using the YAML-RPC protocol
bool	isConnected ()
	returns True if the object is currently connected to the server
	setConnectTimeout (int to)
	sets the connect timeout from an integer in milliseconds
	setConnectTimeout (date to)
	sets the connect timeout from a relative date/time value (i.e. 30s)
	setTimeout (int to)
	sets the send/receive I/O timeout from an integer in milliseconds
	setTimeout (date to)
	sets the send/receive I/O timeout from a relative date/time value (i.e. 30s)
*date	getTimeout ()
	gets the send/receive I/O timeout as a relative date/time value
*date	getConnectTimeout ()
	gets the connect timeout as a relative date/time value
	reconnect ()
	if a connection is established, closes the connection and reconnects immediately
	forceXmlRpc ()
	forces the use of the XML-RPC protocol
	forceYamlRpc ()
	forces the use of the (proprietary) YAML-RPC protocol
auto	methodGate (string api)
	this method is used to redirect calls to unknown methods as the method name when calling the server
auto	memberGate (string api)
	this method is used to redirect calls to unknown methods as the method name when calling the server
auto	callAPIArgs (string api, auto args, bool literal=False)
	with this method you can call a method on the server and give the argument list directly as a list
auto	callAPIArgsWithInfo (reference< hash< auto > > info, string api, auto args, bool literal=False)
	with this method you can call a method on the server and give the argument list directly as a list and it also requires a reference to a hash as the first argument, which will return technical information about the call
auto	callAPI (string api)
	with this method you can call a method on the server, the arguments to the server method should follow the method name normally as arguments to this method
	setQueue (Queue n_q)
	this method allows you to set a Queue object to get I/O events from the underlying HTTPClient object

Additional Inherited Members
Static Public Member Methods inherited from OMQ::QorusSystemAPIHelperBase
static hash< auto >	toConfig (hash< auto > info)
	returns a hash of configuration information for the object

Detailed Description

class used to call the Qorus system API for a remote Qorus instance through the network API

See also

QorusSystemAPIHelperBase for the method documentation

Member Function Documentation

constructor() [1/2]

OMQ::QorusSystemAPIHelper::constructor	(	*hash< auto >	opts,
		*code	init
	)

creates the object based on the options passed

Parameters

opts

optional hash with the following keys: connect_timeout: the connection timeout in seconds http_version: the HTTP version string (def: "1.1") local_token_ttl: the time in seconds that local tokens are valid (only applies if use_local_token is true) max_redirects: the maximum number of redirects proxy: any HTTP/S proxy to use timeout: the I/O timeout in seconds url: the target URL use_local_token: a boolean option; if true a local token with internal system permissions will be included in all requests; only valid for loopback connections to the current server

init

an optional initialization closure to be called with the RPC object as the sole argument

See also

ValidClientAPIOpts

constructor() [2/2]

OMQ::QorusSystemAPIHelper::constructor

(

string

name

)

creates the object based on the connection information for the given remote connection

Parameters

name	the name of the remote connection

---

The documentation for this class was generated from the following file:

• qorus-common-server-api.ql