Qore JsonRpcConnection Module Reference  1.2
JsonRpcConnection::JsonRpcConnection Class Reference

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

Inherits HttpBasedConnection.

Public Member Methods

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

Static Public Member Methods

static deprecated JsonRpcConnection make (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
 DEPRECATED: static constructor. More...
 

Private Member Methods

Qore::Json::JsonRpcClient getImpl (bool connect=True, *hash rtopts)
 returns a Qore::Json::JsonRpcClient object More...
 
hash< ConnectionConstructorInfo > getConstructorInfoImpl ()
 returns a hash that can be used to contruct the object dynamically 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() [1/2]

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

DEPRECATED: creates the JsonRpcConnection object.

Parameters
namethe name of the connection
descconnection description
urlconnection URL (potentially with password info)
monitormonitoring flag
optsconnection options
urlhbroken down URL hash (as returned by Qore::parse_url())
Deprecated:
since Qore 0.9

◆ constructor() [2/2]

JsonRpcConnection::JsonRpcConnection::constructor ( string  name,
string  description,
string  url,
hash  attributes = {},
hash  options = {} 
)

creates the JsonRpcConnection object

Parameters
namethe name of the connection
descriptionconnection description
urlconnection URL (potentially with password info)
attributesvarious attributes. See below
optionsconnection options

See AbstractConnection::constructor() for attributes and options reference.

◆ getConstructorInfoImpl()

hash<ConnectionConstructorInfo> JsonRpcConnection::JsonRpcConnection::getConstructorInfoImpl ( )
private

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

Since
JsonRpcConnection 1.1

◆ getImpl()

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

returns a Qore::Json::JsonRpcClient object

Parameters
connectif True, then the connection is returned already connected
rtoptsthis 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

◆ make()

static deprecated JsonRpcConnection JsonRpcConnection::JsonRpcConnection::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