1. class
  2. Comodojo
  3. \
  4. RpcClient
  5. \
  6. RpcClient

RpcClient

class RpcClient (View source)

Comodojo RPC client. It's able to talk in XML and JSON (2.0).

It optionally supports a not standard encrypted transport

Traits

Protocol
Encryption
Encoding
LoggerTrait

Constants

JSONRPC

XMLRPC

Properties

static protected array $supported_protocols Supported RPC protocols from Protocol

Methods

Protocol
setProtocol(string $protocol)

Set RPC protocol

from Protocol
string
getProtocol()

Get RPC protocol

from Protocol
Encryption
setEncryption(string $key)

Set encryption key

from Encryption
string
getEncryption()

Get encryption key

from Encryption
Encoding
setEncoding(string $encoding)

Set encoding (default to utf-8)

from Encoding
string
getEncoding()

Get encoding

from Encoding
__construct(string $server, LoggerInterface $logger = null, Transport $transport = null)

Class constructor

getTransport()

No description

getRequest()

No description

RpcClient
setAutoclean(bool $mode = true)

Set autoclean on/off

getAutoclean()

No description

addRequest(RpcRequest $request)

No description

getPayload(Processor $processor = null)

No description

mixed
send()

Send request(s) to server

Details

in Protocol at line 46
Protocol setProtocol(string $protocol)

Set RPC protocol

Parameters

string $protocol RPC protocol

Return Value

Protocol

Exceptions

Exception

in Protocol at line 65
string getProtocol()

Get RPC protocol

Return Value

string

in Encryption at line 41
Encryption setEncryption(string $key)

Set encryption key

This will enable the NOT-STANDARD payload encryption

Parameters

string $key Encryption key

Return Value

Encryption

Exceptions

Exception

in Encryption at line 56
string getEncryption()

Get encryption key

Return Value

string

in Encoding at line 35
Encoding setEncoding(string $encoding)

Set encoding (default to utf-8)

Parameters

string $encoding Characters encoding

Return Value

Encoding

in Encoding at line 48
string getEncoding()

Get encoding

Return Value

string

at line 91
__construct(string $server, LoggerInterface $logger = null, Transport $transport = null)

Class constructor

Parameters

string $server Remote RPC server address
LoggerInterface $logger Logger interface
Transport $transport Transport Interface

Exceptions

InvalidArgumentException
Exception

at line 123
getTransport()

at line 129
getRequest()

at line 143
RpcClient setAutoclean(bool $mode = true)

Set autoclean on/off

Parameters

bool $mode If true, requests will be removed from queue at each send()

Return Value

RpcClient

at line 151
getAutoclean()

at line 157
addRequest(RpcRequest $request)

Parameters

RpcRequest $request

at line 165
getPayload(Processor $processor = null)

Parameters

Processor $processor

at line 195
mixed send()

Send request(s) to server

Return Value

mixed

Exceptions

RpcException
HttpException
XmlrpcException
Exception