YamlRpcClient::YamlRpcConnection Class Reference

class for YAML-RPC connections; returns YamlRpcClient objects More...

#include <YamlRpcClient.qm.dox.h>

Inherits ConnectionProvider::HttpBasedConnection.

Public Member Methods
void	constructor (string url, hash< auto > attributes, string name, string description, hash< auto > options)
	creates the YamlRpcConnection object
void	constructor (hash< auto > config, soft< hash< auto > > attr)
	Creates the YamlRpcConnection object.
string	getType ()
	returns "yamlrpc"
YamlRpcClient	getImpl (bool connect, soft< hash< auto > > rtopts)
	returns a YamlRpcClient::YamlRpcClient object
hash< ConnectionSchemeInfo >	getConnectionSchemeInfoImpl ()
	Returns the ConnectionSchemeInfo hash for this object.

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

Detailed Description

class for YAML-RPC connections; returns YamlRpcClient objects

supports the following options:

• "http_version": HTTP version to use ("auto", "1.0", "1.1", or "2.0", defaults to "auto"); HTTP/2 ("2.0" or "auto") requires TLS and is negotiated via ALPN

  • "max_redirects": maximum redirects to support
  • "proxy": proxy URL to use
  • "timeout": transfer timeout to use in milliseconds
  • "connect_timeout": connection timeout to use in milliseconds

  See also

  YamlRpcClient::constructor for more information on the above options

Member Function Documentation

constructor() [1/2]

void YamlRpcClient::YamlRpcConnection::constructor	(	hash< auto >	config,
		soft< 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]

void YamlRpcClient::YamlRpcConnection::constructor	(	string	url,
		hash< auto >	attributes,
		string	name,
		string	description,
		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,
		soft< hash< auto > >	rtopts
	)

returns a YamlRpcClient::YamlRpcClient object

Parameters

connect	if True, then the connection is returned already connected
rtopts	this connection type does not accept any runtime option, so this parameter is ignored

Returns

a YamlRpcClient::YamlRpcClient object

---

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

• doxygen/qlib/YamlRpcClient/YamlRpcClient.qm.dox.h