Class \Prado\Web\Services\TRpcService

TRpcService class

The TRpcService class is a generic class that can be extended and used to implement rpc services using different servers and protocols.

A server is a TModule that must subclass TRpcServer: its role is to be an intermediate, moving data between the service and the provider. The base TRpcServer class should suit the most common needs, but can be sublassed for logging and debugging purposes, or to filter and modify the request/response on the fly.

A protocol is a TModule that must subclass TRpcProtocol: its role is to implement the protocol that exposes the rpc api. Prado already implements two protocols: TXmlRpcProtocol for Xml-Rpc request and TJsonRpcProtocol for JSON-Rpc requests.

A provider is a TModule that must subclass TRpcApiProvider: its role is to implement the methods that are available through the api. Each defined api must be a sublass of the abstract class TRpcApiProvider and implement its methods.

The flow of requests and reponses is the following: Request <-> TRpcService <-> TRpcServer <-> TRpcProtocol <-> TRpcApiProvider <-> Response

To define an rpc service, add the proper application configuration:

<service id="rpc" class="Prado\Web\Services\TRpcService">
	 <rpcapi id="customers" class="Application.Api.CustomersApi" />
  <modules>
    <!--  register any module needed by the service here -->
  </modules>
</service>

An api can be registered adding a proper <rpcapi ..> definition inside the service configuration. Each api definition must contain an id property and a class name expressed in namespace format. When the service receives a request for that api, the specified class will be instanciated in order to satisfy the request.

Class hierarchy

\Prado\Web\Services\TRpcService

\Prado\TService implements IService

\Prado\TApplicationComponent

\Prado\TComponent

Author: Robin J. Rogge <rrogge@bigpoint.net>
Since: 3.2

Methods summary
`public`	`createApiProvider(TRpcProtocol $protocolHandler, string $providerId) : mixed` Creates the API provider instance for the current request
`public`	`init(TXmlElement $config) : mixed` Initializes the service
`public`	`loadConfig(TXmlElement $xml) : mixed` Loads the service configuration
`public`	`run() : mixed` Runs the service

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEnabled, getEventHandlers, getID, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, init, isa, listen, publishAsset, publishFilePath, raiseEvent, run, setEnabled, setID, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Constants summary
`public mixed`	`BASE_API_PROVIDER` const string base api provider class which every API must extend	`\Prado\Web\Services\TRpcApiProvider::class`
`public mixed`	`BASE_RPC_SERVER` const string base RPC server implementation	`\Prado\Web\Services\TRpcServer::class`

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`