Qore YamlRpcClient Module Reference  1.1
 All Classes Namespaces Functions Variables Pages
YamlRpcClient::YamlRpcConnection Class Reference

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

Inherits HttpBasedConnection.

Public Member Functions

 constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
 creates the YamlRpcConnection object More...
 
hash getOptions ()
 gets options More...
 
*hash getDefaultOptions ()
 returns default options
 
string getType ()
 returns "yamlrpc"
 

Static Public Member Functions

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

Private Member Functions

YamlRpcClient getImpl (bool connect=True, *hash rtopts)
 returns a YamlRpcClient::YamlRpcClient object 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

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

creates the YamlRpcConnection 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())
YamlRpcClient YamlRpcClient::YamlRpcConnection::getImpl ( bool  connect = True,
*hash  rtopts 
)
private

returns a YamlRpcClient::YamlRpcClient object

Parameters
connectif True, then the connection is returned already connected
rtoptsthis connection type does not accept any runtime option, so this parameter is ignored
Returns
a YamlRpcClient::YamlRpcClient object
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