YamlRpcClient::YamlRpcClient Class Reference

defines a YAML-RPC client class More...

#include <YamlRpcClient.qm.dox.h>

Inherits Qore::HTTPClient.

Public Member Methods
auto	call (string method)
	makes a method call to the YAML-RPC server using the remaining arguments after the method name as the list of arguments to send

Static Public Member Methods
static string	makeRequest (string method, auto arg, int flags)
	makes a YAML-RPC request string

Public Attributes
const auto	Version = ...
	YAML-RPC Client Version.
const auto	DefaultOptions = ...
	default options for the YamlRpcClient::constructor()
const auto	VersionString = ...
	YAML-RPC Client Version String.
const auto	DefaultHeaders = ...
	default HTTP headers

Detailed Description

defines a YAML-RPC client class

The YamlRpcClient class will correctly serialize YAML-RPC messages, send them to the server, deserialize the responses and return a Qore-language data structure for the response.

YAML-RPC is a proprietary HTTP-based RPC protocol; for a description of the YAML-RPC protocol implemented by the YamlRpcClient class, see YAML-RPC Protocol Implementation.

Note

• if no URI path is given in the constructor(), the default path used is "/YAML"
• subclassed from Qore''s HTTPClient class

Member Function Documentation

call()

auto YamlRpcClient::YamlRpcClient::call

(

string

method

)

makes a method call to the YAML-RPC server using the remaining arguments after the method name as the list of arguments to send

Parameters

method

the remote method to call

Returns

the value returned from the server; if no error occurred, then a hash is returned with a result key (see YAML-RPC Non-Error Responses), otherwise a hash is returned with an error key containing the error information (see YAML-RPC Error Responses)

---

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

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