JsonRpcConnection::JsonRpcConnection Class Reference

class for JSON-RPC connections; returns Qore::Json::JsonRpcClient objects More...

Inherits HttpBasedConnection.

Public Member Functions
	constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	creates the JsonRpcConnection object More...
hash	getOptions ()
	gets options More...
*hash	getDefaultOptions ()
	returns default options
string	getType ()
	returns "jsonrpc"

Static Public Member Functions
static JsonRpcConnection	make (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	static constructor

Private Member Functions
Qore::Json::JsonRpcClient	getImpl (bool connect=True, *hash rtopts)
	returns a Qore::Json::JsonRpcClient object More...

Detailed Description

class for JSON-RPC connections; returns Qore::Json::JsonRpcClient 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

JsonRpcClient::constructor() for more information on the above options

Member Function Documentation

constructor()

JsonRpcConnection::JsonRpcConnection::constructor	(	string	name,
		string	desc,
		string	url,
		bool	monitor,
		*hash	opts,
		hash	urlh
	)

creates the JsonRpcConnection 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())

getImpl()

Qore::Json::JsonRpcClient JsonRpcConnection::JsonRpcConnection::getImpl ( bool  connect = True, *hash  rtopts  )

private

returns a Qore::Json::JsonRpcClient object

Parameters

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

Returns

a Qore::Json::JsonRpcClient object

getOptions()

hash JsonRpcConnection::JsonRpcConnection::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

JsonRpcClient::constructor() for more information on the above options