Qorus Integration Engine®  4.0.3_git
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:
OMQ::QorusSystemAPIHelperBase

Public Member Methods

 constructor (*hash opts, *code init)
 creates the object based on the options passed More...
 
 constructor (string name)
 creates the object based on the connection information for the given remote connection More...
 
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 n_opts, *code n_init)
 creates the object based on the options passed More...
 
 copy ()
 creates a copy of the object
 
 setOptions ()
 this variant of the setOptions() method does nothing when called with no argument
 
 setOptions (hash opts)
 sets connection options More...
 
 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 More...
 
*date getConnectTimeout ()
 gets the connect timeout as a relative date/time value More...
 
 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 More...
 
any methodGate (string api)
 this method is used to redirect calls to unknown methods as the method name when calling the server
 
any memberGate (string api)
 this method is used to redirect calls to unknown methods as the method name when calling the server
 
any callAPIArgs (string api, any args, bool literal=False)
 with this method you can call a method on the server and give the argument list directly as a list More...
 
any callAPIArgsWithInfo (reference info, string api, any 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 More...
 
any 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 More...
 
 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 toConfig (hash 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  opts,
*code  init 
)

creates the object based on the options passed

Parameters
optsoptional hash with the following keys:
  • timeout
  • connect_timeout
  • http_version
  • url
  • max_redirects
  • proxy
initan 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
namethe name of the remote connection

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