Qorus Integration Engine®  4.0.3.p2_git
OMQ::ConnectionScheme Class Reference

defines the class of object returned by the "get_schemes()" function in custom user modules More...

Public Member Methods

 constructor (string name, code maker)
 DEPRECATED: creates the object from the arguments passed. More...
 
 constructor (string name, string connection_class_name)
 

Public Attributes

string name
 the name of the scheme
 
*code maker
 DEPRECATED since Qorus 4.0: the callable object to create the object; see subclass docs for details of the arguments for this callable member.
 
string connection_class_name
 name of the connection class. Eg. "RestConnection"
 

Detailed Description

defines the class of object returned by the "get_schemes()" function in custom user modules

See also
qorus.connection-modules

Member Function Documentation

◆ constructor() [1/2]

OMQ::ConnectionScheme::constructor ( string  name,
code  maker 
)

DEPRECATED: creates the object from the arguments passed.

Parameters
namethe scheme or connection type of the connection (ex: "http")
makera closure or call reference to code that will return the connection object; this must support the following return type: ConnectionProvider::AbstractConnection, arguments:
  • name (string): the name of the connection
  • desc (string): connection description
  • url (string): connection URL
  • monitor (bool): monitoring flag
  • opts (*hash): connection options
  • urlh (hash) broken down URL hash (as returned by Qore::parse_url())
Deprecated:
since Qorus 4.0

◆ constructor() [2/2]

OMQ::ConnectionScheme::constructor ( string  name,
string  connection_class_name 
)
Parameters
namethe scheme or connection type of the connection (ex: "http")
connection_class_namea name of the AbstractConnection inherited class

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