Extension of scaytrase/rpc-common
- JSON RPC Interfaces
- JSON RPC client
- Async with Guzzle
- Automatic batch with multiple requests or
LazyClientDecorator
- Configure a Guzzle client.
- Instantiate the client:
use ScayTrase\Api\JsonRpc\JsonRpcClient;
$client = new JsonRpcClient($guzzleClient, 'http://endpoint/url/');- Optionally pass the ID generator as third argument and the PSR-3 logger as the fourth argument
Simple UUID generator and PSR-3 NullLogger are used by default. ID is generated for RpcRequestInterface instances.
If request is instance of JsonRpcRequestInterface and does not contain an ID assigned, the request is traited as
notification request and will not receive the response from server.
- Create a
RpcRequestInterfaceinstance
With JsonRpcRequest class:
$request = new \ScayTrase\Api\JsonRpc\JsonRpcRequest('my/method', ['param1' => 'val1'], 'request_id');
$notification = new \ScayTrase\Api\JsonRpc\JsonRpcRequest('my/method', ['param1' => 'val1']);With JsonRpcNotification class:
$notification = new \ScayTrase\Api\JsonRpc\JsonRpcNotification('my/method', ['param1' => 'val1']);With custom RpcRequestInterface implementation:
final class MyRpcRequest implements \ScayTrase\Api\Rpc\RpcRequestInterface
{
public function getMethod()
{
return 'my/method';
}
public function getParameters()
{
return ['param1' => 'val1'];
}
}
$request = new MyRpcRequest;- Call the client
/** @var \ScayTrase\Api\Rpc\RpcClientInterface $client */
/** @var \ScayTrase\Api\Rpc\RpcRequestInterface $request */
$collection = $client->invoke($request);
$collection = $client->invoke([$request]);The collection object contains the mapping between the requests and the responses
/** @var \ScayTrase\Api\Rpc\RpcRequestInterface $request */
/** @var \ScayTrase\Api\Rpc\ResponseCollectionInterface $collection */
$response = $collection->getResponse($request);Refer scaytrase/rpc-common base library for some
useful decorators:
CacheableRpcClientLazyRpcClientLoggableRpcClientProfiledClientTraceableClient