This class provides an easy way to call Qorus API functions using the network API.
More...
|
| | 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
|
| |
This class provides an easy way to call Qorus API functions using the network API.
the class does not provide any connection pooling; it is thread-safe, but requests from concurrent threads will block while a request from another thread is in progress. This class uses YAML-RPC by default, but if calling a Qorus server that does not support YAML-RPC, will automatically fall back to XML-RPC
- Note
- this should not be used directly; use subclass OMQ::QorusSystemAPIHelper (in server code) or OMQ::Client::QorusSystemAPIHelper (in client code) instead
