class for YAML-RPC connections; returns YamlRpcClient objects
More...
#include <YamlRpcClient.qm.dox.h>
|
const | ConnectionScheme = ... |
| Connection entry info.
|
|
class for YAML-RPC connections; returns YamlRpcClient objects
supports the following options:
◆ constructor() [1/2]
YamlRpcClient::YamlRpcConnection::constructor |
( |
hash< auto > | config, |
|
|
*hash< auto > | attr ) |
Creates the YamlRpcConnection 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]
YamlRpcClient::YamlRpcConnection::constructor |
( |
string | name, |
|
|
string | description, |
|
|
string | url, |
|
|
hash< auto > | attributes = {}, |
|
|
hash< auto > | options = {} ) |
creates the YamlRpcConnection object
- Parameters
-
name | the name of the connection |
description | connection description |
url | connection URL (potentially with password info) |
attributes | various attributes. See below |
options | connection options |
See AbstractConnection::constructor() for attributes
and options
reference.
◆ getImpl()
YamlRpcClient YamlRpcClient::YamlRpcConnection::getImpl |
( |
bool | connect = True, |
|
|
*hash< auto > | rtopts ) |
|
protected |
The documentation for this class was generated from the following file:
- doxygen/qlib/YamlRpcClient/YamlRpcClient.qm.dox.h