JsonRpcConnection::JsonRpcConnection Class Reference

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

#include <JsonRpcConnection.qm.dox.h>

Inherits ConnectionProvider::HttpBasedConnection.

Public Member Methods
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the JsonRpcConnection object More...
string	getType ()
	returns "jsonrpc"

Public Attributes
const	ConnectionScheme
	Connection entry info.

Private Member Methods
Qore::Json::JsonRpcClient	getImpl (bool connect=True, *hash< auto > rtopts)
	returns a Qore::Json::JsonRpcClient object More...
hash< ConnectionSchemeInfo >	getConnectionSchemeInfoImpl ()
	Returns the ConnectionSchemeInfo hash for this object.

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	description,
		string	url,
		hash< auto >	attributes = {},
		hash< auto >	options = {}
	)

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

Qore::Json::JsonRpcClient JsonRpcConnection::JsonRpcConnection::getImpl ( bool  connect = True, *hash< auto >  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

---

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

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