BusyLightDataProvider::BusyLightConnection Class Reference

class for BUSYLIGHT connections More...

#include <BusyLightConnection.qc.dox.h>

Inheritance diagram for BusyLightDataProvider::BusyLightConnection:

Public Member Methods
void	constructor (string url, hash< auto > attr, string name, string desc, hash< auto > options, soft< LoggerInterface > logger)
	Creates the object from the arguments.
void	constructor (hash< auto > config, soft< hash< auto > > attr)
	Creates the object from the arguments.
string	getType ()
	returns the string type name for the connection object
AbstractDataProvider	getDataProvider (soft< hash< auto > > constructor_options)
	Returns a BusyLightDataProvider object for this connection.
hash< ConnectionSchemeInfo >	getConnectionSchemeInfoImpl ()
	Returns the ConnectionSchemeInfo hash for this object.
soft< hash< string, hash< DataProviderOptionInfo > > >	getDataProviderConstructorOptionsImpl ()
	Returns a hash of data provider constructor option info, if applicable.
void	setChildCapabilities ()
	Override to set child data provider capabilities once per child class.
void	setRealUrl (soft< string > url)
	Called by the constructor to set the real URL.

Public Attributes
const auto	ConnectionScheme = ...
	Connection entry info.

Detailed Description

class for BUSYLIGHT connections

supports the options from BusyLightDataProvider::ConstructorOptions

Member Function Documentation

constructor()

void BusyLightDataProvider::BusyLightConnection::constructor	(	hash< auto >	config,
		soft< hash< auto > >	attr
	)

Creates the object from the arguments.

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

getDataProvider()

AbstractDataProvider BusyLightDataProvider::BusyLightConnection::getDataProvider

(

soft< hash< auto > >

constructor_options

)

Returns a BusyLightDataProvider object for this connection.

Parameters

constructor_options

any additional constructor options for the data provider

Returns

a data provider object for this connection, if supported

getDataProviderConstructorOptionsImpl()

soft< hash< string, hash< DataProviderOptionInfo > > > BusyLightDataProvider::BusyLightConnection::getDataProviderConstructorOptionsImpl

(

)

Returns a hash of data provider constructor option info, if applicable.

Returns

a hash of data provider constructor option info for the primary data provider, if applicable

setRealUrl()

void BusyLightDataProvider::BusyLightConnection::setRealUrl

(

soft< string >

url

)

Called by the constructor to set the real URL.

@path the new URL

sets the real HTTP URL for HTTP-based connections

---

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

• doxygen/qlib/BusyLightDataProvider/BusyLightConnection.qc.dox.h