YamlRpcClient::YamlRpcConnection Class Reference

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

Inherits HttpBasedConnection.

Public Member Methods
deprecated	constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	DEPRECATED: creates the YamlRpcConnection object. More...
	constructor (string name, string description, string url, hash attributes={}, hash options={})
	creates the YamlRpcConnection object More...
hash	getOptions ()
	gets options More...
*hash	getDefaultOptions ()
	returns default options
string	getType ()
	returns "yamlrpc"

Static Public Member Methods
static deprecated YamlRpcConnection	make (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	DEPRECATED: static constructor. More...

Private Member Methods
YamlRpcClient	getImpl (bool connect=True, *hash rtopts)
	returns a YamlRpcClient::YamlRpcClient object More...
hash< ConnectionConstructorInfo >	getConstructorInfoImpl ()
	returns a hash that can be used to contruct the object dynamically More...

Detailed Description

class for YAML-RPC connections; returns YamlRpcClient objects

supports the following options:

• "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")

  • "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]

deprecated YamlRpcClient::YamlRpcConnection::constructor	(	string	name,
		string	desc,
		string	url,
		bool	monitor,
		*hash	opts,
		hash	urlh
	)

DEPRECATED: creates the YamlRpcConnection object.

Parameters

name	the name of the connection
desc	connection description
url	connection URL (potentially with password info)
monitor	monitoring flag
opts	connection options
urlh	broken down URL hash (as returned by Qore::parse_url())

Deprecated:

since Qore 0.9

constructor() [2/2]

YamlRpcClient::YamlRpcConnection::constructor	(	string	name,
		string	description,
		string	url,
		hash	attributes = {},
		hash	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.

getConstructorInfoImpl()

hash<ConnectionConstructorInfo> YamlRpcClient::YamlRpcConnection::getConstructorInfoImpl ( )

private

returns a hash that can be used to contruct the object dynamically

Since

YamlRpcClient 1.2

getImpl()

YamlRpcClient YamlRpcClient::YamlRpcConnection::getImpl ( bool  connect = True, *hash  rtopts  )

private

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

getOptions()

hash YamlRpcClient::YamlRpcConnection::getOptions

(

)

gets options

Returns

returns a hash with the following supported options:

• "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
  • "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

make()

static deprecated YamlRpcConnection YamlRpcClient::YamlRpcConnection::make ( string  name, string  desc, string  url, bool  monitor, *hash  opts, hash  urlh  )

static

DEPRECATED: static constructor.

Deprecated:

since Qore 0.9 in favor of new constructor and Qore::Reflection