Class: XML_RPC2_Backend_Xmlrpcext_Server

Source Location: /XML_RPC2-1.1.2/XML/RPC2/Backend/Xmlrpcext/Server.php

Class Overview

XML_RPC2_Server
   |
   --XML_RPC2_Backend_Xmlrpcext_Server

XML_RPC server class XMLRPCext extension-based backend

Author(s):

Sergio Carvalho <sergio.carvalho at portugalmail.com>

Copyright:

2004-2006 Sergio Carvalho

Inherited Variables

Class: XML_RPC2_Server

XML_RPC2_Server::$autoDocument
XML_RPC2_Server::$autoDocumentExternalLinks
XML_RPC2_Server::$callHandler
XML_RPC2_Server::$encoding
XML_RPC2_Server::$input
XML_RPC2_Server::$prefix
XML_RPC2_Server::$signatureChecking

Inherited Methods

Class: XML_RPC2_Server

XML_RPC2_Server::__construct(): Create a new XML-RPC Server.
XML_RPC2_Server::autoDocument(): autoDocument. Produce an HTML page from the result of server introspection
XML_RPC2_Server::create(): Factory method to select a backend and return a new XML_RPC2_Server based on the backend
XML_RPC2_Server::errorToException(): Transform an error into an exception
XML_RPC2_Server::getContentLength(): Gets the content legth of a serialized XML-RPC message in bytes
XML_RPC2_Server::handleCall(): Receive the XML-RPC request, decode the HTTP payload, delegate execution to the call handler, and output the encoded call handler response.

Class Details

[line 64]
XML_RPC server class XMLRPCext extension-based backend

The XML_RPC2_Server does the work of decoding and encoding xml-rpc request and response. The actual method execution is delegated to the call handler instance.

The XML_RPC server is responsible for decoding the request and calling the appropriate method in the call handler class. It then encodes the result into an XML-RPC response and returns it to the client.

Author: Sergio Carvalho <sergio.carvalho@portugalmail.com>
Copyright: 2004-2006 Sergio Carvalho
Link: http://pear.php.net/package/XML_RPC2
License: LGPL License 2.1

[ Top ]

Method Detail

__construct (Constructor) [line 87]

XML_RPC2_Backend_Xmlrpcext_Server __construct(
object
$callHandler, [array
$options = array()])

Create a new XML-RPC Server.

The constructor receives a mandatory parameter: the Call Handler. The call handler executes the actual method call. XML_RPC2 server acts as a protocol decoder/encoder between the call handler and the client

Overrides XML_RPC2_Server::__construct() (Create a new XML-RPC Server.)

Parameters:

object	`$callHandler`	—
array	`$options`	—	associative array of options

[ Top ]

epiFunctionHandlerAdapter [line 110]

void epiFunctionHandlerAdapter(
string
$method_name, array
$params, array
$app_data)

This is an adapter between XML_RPC2_CallHandler::__call and xmlrpc_server_register_method callback interface

Access: protected

Parameters:

string	`$method_name`	—	Method name
array	`$params`	—	Parameters
array	`$app_data`	—	Application data (ignored)

[ Top ]

getResponse [line 143]

string getResponse(
)

get the XML response of the XMLRPC server

Return: the XML response
Access: public

[ Top ]

handleCall [line 123]

void handleCall(
)

Respond to the XML-RPC request.

handleCall reads the XML-RPC request from the raw HTTP body and decodes it. It then calls the corresponding method in the call handler class, returning the encoded result to the client.

Access: public

Overrides XML_RPC2_Server::handleCall() (Receive the XML-RPC request, decode the HTTP payload, delegate execution to the call handler, and output the encoded call handler response.)

[ Top ]