QorusSystemRemoteService Class Reference

system remote service More...

Inherits QorusSystemService.

Public Member Methods
QorusSystemAPIHelper	get (string name)
	get service method
QorusSystemRestHelper	get_rest (string name)
	get_rest service method
list	get_remote_list ()
	get_remote_list service method
list	list ()
	list service method
hash	get_config (*string name)
	get_config service method
hash	info ()
	info service method
string	ping_local ()
	ping_local service method
hash	ping (string name)
	ping service method

Static Public Member Methods
static	reload ()
	reload service method

Detailed Description

system remote service

Member Function Documentation

get()

QorusSystemAPIHelper QorusSystemRemoteService::get ( string  name )

inline

get service method

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

get_rest()

QorusSystemRestHelper QorusSystemRemoteService::get_rest ( string  name )

inline

get_rest service method

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

info()

hash QorusSystemRemoteService::info ( )

inline

info service method

Returns

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

ping()

hash QorusSystemRemoteService::ping ( string  name )

inline

ping service method

Returns

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

ping_local()

string QorusSystemRemoteService::ping_local ( )

inline

ping_local service method

Deprecated:

use PUT /api/latest/remote/qorus/{name}?action=ping instead

reload()

static QorusSystemRemoteService::reload ( )

inlinestatic

reload service method

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

---

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

• remote-v5.1.qsd