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
	constructor (hash< auto > config, *hash< auto > attr)
	Creates the HttpConnection object.
string	getType ()
	returns "qorus"
DataProvider::AbstractDataProvider	getDataProvider (*hash< auto > constructor_options)
	returns a data provider object for this connection
bool	hasDataProvider ()
	returns True as all Qorus connections return a data provider with the getDataProvider() method
*hash< PingInfo >	ping (int ping_flags)
	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"
	Defauit Qorus ping path.
const	DataProviderSubtypeMap
	Data provider subtypes supported.

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() [1/2]

OMQ::QorusHttpConnection::constructor	(	hash< auto >	config,
		*hash< auto >	attr
	)

Creates the HttpConnection object.

Parameters

config

with the following keys: name (required string): the connection name display_name (optional string): the display name short_desc (optional string): a short description in plain text desc (optional string): a long description with markdown formatting url (required string): the connection URL opts (optional hash): connection options logger (optional LoggerInterface object): logger for the connection

attr

optional connection attributes monitor (optional bool): should the connection be monitored? Default: True enabled (optional bool): is the connection enabled? Default: True locked (optional bool): is the connection locked? Default: False debug_data (optional bool): debug data? Default: False tags (optional hash): tags for the connection; no default value

Exceptions

CONNECTION-OPTION-ERROR

missing or invalid connection option or attribute

constructor() [2/2]

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

(

*hash< auto >

constructor_options

)

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