remote-v4.0.qsd File Reference

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

Classes
class	QorusSystemRemoteService
	main remote service class 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

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/latest/remote/qorus/name
get_remote_list()	REST API: GET /api/latest/remote/qorus?list=true
get_rest()	get_remote_rest_connection()
info()	REST API: GET /api/latest/remote/qorus
list()	REST API: GET /api/latest/remote/qorus?list=true
ping()	REST API: GET /api/latest/remote/qorus/name?action=ping
ping_local()	REST API: GET /api/latest/system?action=ping
reload()	REST API: PUT /api/latest/remote/qorus?action=reload