Qore json Module 1.8.2
Loading...
Searching...
No Matches
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
 
 constructor (hash< auto > config, *hash< auto > attr)
 Creates the object from the arguments.
 
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
 
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() [1/2]

JsonRpcConnection::JsonRpcConnection::constructor ( hash< auto >  config,
*hash< auto >  attr 
)

Creates the object from the arguments.

Parameters
configwith 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
attroptional 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-ERRORmissing or invalid connection option or attribute

◆ constructor() [2/2]

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

◆ getImpl()

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

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