remote-v3.1.qsd File Reference

DEPRECATED: provides backwards-compatible access to predefined remote Qorus instances. More...

Functions
	remote.init ()
	initalizes the system datasource service
QorusSystemAPIHelper	remote.get (string name)
	Setup and return a new OMQ::QorusSystemAPIHelper object to be used in user source code. More...
QorusSystemRestHelper	remote.get_rest (string name)
	Setup and return a new OMQ::QorusSystemRestHelper object to be used in user source code. More...
list	remote.get_remote_list ()
	returns a list of non-local instances; loopback entries are filtered out
	remote.reload ()
	refresh cached remote instances More...
list	remote.list ()
	show available instances in a list
hash	remote.get_config (*string name)
	returns a hash giving the configuration of the given connection; this is internal in order to prohibit login info from being sent in external calls More...
hash	remote.info ()
	return available instances as a hash keyed by name, where the value is the description of the connection More...
string	remote.ping_local ()
	local part of the ping method mechanism. It calls *local* remote service. More...
hash	remote.ping ()
	test the remote connection(s). Optional argument 'name' can limit the ping to given remote instance More...

Detailed Description

DEPRECATED: provides backwards-compatible access to predefined remote Qorus instances.

Deprecated:

This service is now deprecated and only included for backwards compatibility. The functionality previously implemented by this service is now built in to the Qorus server itself and integrated with connection monitoring and automatic interface management.

Qorus administrators can define connection parameters for remote Qorus server instances (ie accessible with DataStream/REST, YAML-RPC, XML-RPC or JSON-RPC). See the table below for functions that can be used to acquire OMQ::QorusSystemAPIHelper and OMQ::QorusSystemRestHelper objects in user code (server and client).

The main advantages of remote Qorus server instances as a first-class integration object are as follows:

• consistency: provides a single point of access to remote Qorus system connection information
• improves security: login information is not stored publicly
• convenience: all required config information is managed and accessible in a single location

See Also

• Qorus to Qorus Connections
• Remote Qorus Instance Configuration File
• Qorus system remoteconnections-file option

References to new, non-deprecated functionality are provided in the documentation below; however the following table provides a mapping:

Remote Method to Remote API Mapping

Method	Function or API
get()	get_remote_rpc_connection()
get_config()	REST API: GET /api/remote/qorus/name
get_remote_list()	REST API: GET /api/remote/qorus?list=true
get_rest()	get_remote_rest_connection()
info()	REST API: GET /api/remote/qorus
list()	REST API: GET /api/remote/qorus?list=true
ping()	REST API: GET /api/remote/qorus/name?action=ping
ping_local()	REST API: GET /api/system?action=ping
reload()	REST API: PUT /api/remote/qorus?action=reload

Function Documentation

QorusSystemAPIHelper remote.get

(

string

name

)

Setup and return a new OMQ::QorusSystemAPIHelper object to be used in user source code.

Parameters

name	a string key/name of the remote instance

Returns

OMQ::QorusSystemAPIHelper instance; see OMQ::QorusSystemAPIHelperBase for full API

Exceptions

REMOTE-GET-ERROR

There is something wrong in the configuration; see error description for more info

Deprecated:

use get_remote_rpc_connection() instead

Note

- internal: True (this method can only be called internally)

hash remote.get_config

(

*string

name

)

returns a hash giving the configuration of the given connection; this is internal in order to prohibit login info from being sent in external calls

Note

- internal: True (this method can only be called internally)

QorusSystemRestHelper remote.get_rest

(

string

name

)

Setup and return a new OMQ::QorusSystemRestHelper object to be used in user source code.

Parameters

name	a string key/name of the remote instance

Returns

OMQ::QorusSystemRestHelper instance; see OMQ::QorusSystemRestHelperBase for full API

Exceptions

REMOTE-GET-ERROR

There is something wrong in the configuration; see error description for more info

Deprecated:

use get_remote_rest_connection() instead

Note

- internal: True (this method can only be called internally)

hash remote.info

(

)

return available instances as a hash keyed by name, where the value is the description of the connection

Returns

a hash of available instances keyed by name, where the value is the description of the connection

hash remote.ping

(

)

test the remote connection(s). Optional argument 'name' can limit the ping to given remote instance

Returns

a hash with (name : connection info) from the remote instance values

string remote.ping_local

(

)

local part of the ping method mechanism. It calls *local* remote service.

Deprecated:

Since resolution of bug 698, use omq.system.ping instead

remote.reload

(

)

refresh cached remote instances

It is necessary to call this method (or reset the service) when the configuration changes

Exceptions

REMOTE-LOAD-ERROR	Missing config file or malformed syntax
FILE-OPEN2-ERROR	error opening configuration file