OMQ::QorusHttpConnection Class Reference

Qorus REST connection object. More...

Inheritance diagram for OMQ::QorusHttpConnection:

Collaboration diagram for OMQ::QorusHttpConnection:

Public Member Methods
	constructor (string name, string desc, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the QorusHttpConnection object More...
DataProvider::AbstractDataProvider	getDataProvider ()
	returns a data provider object for this connection More...
bool	hasDataProvider ()
	returns True as all Qorus connections return a data provider with the getDataProvider() method More...
*hash< PingInfo >	ping (bool throw_exception=False)
	returns a hash with the connection status with "ok" and "info" keys

Public Attributes
const	ConnectionScheme
	Connection entry info.
const	DefaultQorusingMethod = "GET"
	Default Qorus ping method.
const	DefaultQorusPingPath = "/api/public/info/instance-key"
	Defauit Qorus ping path.

Private Member Methods
hash< ConnectionSchemeInfo >	getConnectionSchemeInfoImpl ()
	Returns the ConnectionSchemeInfo hash for this object.

Detailed Description

Qorus REST connection object.

accepts the same options as RestConnection as well as:

• conn_timeout: accepted as a synonym for connect_timeout

Note

Despite the name, this class implements a REST connection to remote Qorus servers

Member Function Documentation

constructor()

OMQ::QorusHttpConnection::constructor	(	string	name,
		string	desc,
		string	url,
		hash< auto >	attributes = {},
		hash< auto >	options = {}
	)

creates the QorusHttpConnection object

Parameters

name	the name of the connection
desc	connection description
url	connection URL (potentially with password info)
attributes	connection attributes
options	connection options

getDataProvider()

DataProvider::AbstractDataProvider OMQ::QorusHttpConnection::getDataProvider

(

)

returns a data provider object for this connection

Returns

a data provider object for this connection

hasDataProvider()

bool OMQ::QorusHttpConnection::hasDataProvider

(

)

returns True as all Qorus connections return a data provider with the getDataProvider() method

Returns

True as all Qorus connections return a data provider with the getDataProvider() method

See also

getDataProvider()

---

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

• Connections.qc