From 36fbeaf2e91dbbc7a2cb6d96faaf3c83ac756d52 Mon Sep 17 00:00:00 2001 From: ctrlaltca <> Date: Fri, 31 Aug 2012 13:57:52 +0000 Subject: Quickstart tutorial page for the TRpcService --- .gitattributes | 1 + demos/quickstart/protected/controls/Layout.tpl | 2 +- demos/quickstart/protected/controls/TopicList.tpl | 1 + .../protected/pages/Services/RpcService.page | 74 ++++++++++++++++++++++ 4 files changed, 77 insertions(+), 1 deletion(-) create mode 100755 demos/quickstart/protected/pages/Services/RpcService.page diff --git a/.gitattributes b/.gitattributes index 74f9a204..6541f9fb 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1937,6 +1937,7 @@ demos/quickstart/protected/pages/GettingStarted/sequence.vsd -text demos/quickstart/protected/pages/GettingStarted/zh/Introduction.page -text demos/quickstart/protected/pages/Search.page -text demos/quickstart/protected/pages/Search.php -text +demos/quickstart/protected/pages/Services/RpcService.page -text demos/quickstart/protected/pages/Services/SoapService.page -text demos/quickstart/protected/pages/Services/id/SoapService.page -text demos/quickstart/protected/pages/Tutorial/AddressBook.page -text diff --git a/demos/quickstart/protected/controls/Layout.tpl b/demos/quickstart/protected/controls/Layout.tpl index ac41d1de..2faaf1b0 100644 --- a/demos/quickstart/protected/controls/Layout.tpl +++ b/demos/quickstart/protected/controls/Layout.tpl @@ -50,7 +50,7 @@ diff --git a/demos/quickstart/protected/pages/Services/RpcService.page b/demos/quickstart/protected/pages/Services/RpcService.page new file mode 100755 index 00000000..4eb06f37 --- /dev/null +++ b/demos/quickstart/protected/pages/Services/RpcService.page @@ -0,0 +1,74 @@ + + +

RPC Service

+ +

+RPC Service stands for "Remote Procedure Call" Service and is a common name used to identify a service that exposes an interface that can be called by remote programs in order to execute a procedure. +An RPC Service tipically exposes one or more APIs (Application programming interface), permitting remote clients to make requests to the available methods and receive a proper response. +The interface itself is not bound to a specific programming language, but uses a standard data exchange protocol (tipically xml or json). +PRADO provides TRpcService that makes developing a RPC server application an extremely easy task. +

+ +

+To use TRpcService, configure it in the application specification like following: +

+ + + + + + + + +

+The example specifies a RPC service provider named stockquote which implements the getPrice RPC method in the provider class StockQuote, +

+ +class StockQuote +{ + /** + * @param string $symbol the symbol of the stock + * @return float the stock price + * @soapmethod + */ + public function getPrice($symbol) + { + ....return stock price for $symbol + } + + /** + * Register the available methods + * @return the list of implemented methods + */ + public function registerMethods() + { + return array( + 'getPrice' => array('method' => array($this, 'getPrice')), + ); + } + +} + + +

+PRADO already bundles two common protocols: TXmlRpcService and TJsonRpcService: requests made by clients using one of these protocol will be automatically resolved and will call the user-specified APIs. +

+ +
Note: +TXmlRpcService is based on PHP XML-RPC extension and thus requires the extension to be installed. +
+ +

+With the above simple code, we already finish a simple RPC service that allows other applications to query the price of a specific stock. A client needs to know the exact url of the service, the name of the method and the list of parameters needed by the method. +

+ +// Assuming we're using the json-rpc php library from http://jsonrpcphp.org/ + +require_once 'jsonRPCClient.php'; +$client=new jsonRPCClient('http://path/to/index.php?rpc=stockquote'); +echo $client->getPrice('IBM'); + + + -- cgit v1.2.3