$darkmode
Qore yaml Module 0.7.3
 All Classes Namespaces Functions Variables Groups Pages
YamlRpcClient::YamlRpcConnection Class Reference

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

Inherits HttpBasedConnection.

Public Member Methods

string getType ()
 creates the YamlRpcConnection object More...
 

Public Attributes

const ConnectionScheme
 Connection entry info.
 

Private Member Methods

YamlRpcClient getImpl (bool connect=True, *hash< auto > rtopts)
 returns a YamlRpcClient::YamlRpcClient object More...
 
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl ()
 Returns the ConnectionSchemeInfo hash for this object.
 

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 YamlRpcClient::YamlRpcConnection::getImpl ( bool  connect = True,
*hash< auto >  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
string YamlRpcClient::YamlRpcConnection::getType ( )

creates the YamlRpcConnection 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.returns "yamlrpc"


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