Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

ost::XMLRPC Class Reference

This class impliments a core XMLRPC service without the underlying transports. XML-RPC service building class. More...

#include <xml.h>

Inheritance diagram for ost::XMLRPC::

ost::XMLStream List of all members.

Public Methods

 XMLRPC (size_t bufsize)
 Construct XMLRPC workspace. More...

virtual ~XMLRPC ()
 Destroy XMLRPC object. More...

void begArray (void)
 Create an array. More...

void endArray (void)
 end an array. More...

void Invoke (const char *method)
 Create XMLRPC "method" call in buffer. More...

void Response (bool fault)
 Create XMLRPC "reply" to a method call. More...

void addParam (bool value)
 Add bool param to XMLRPC request. More...

void addMember (const char *name, bool value)
 Add bool member to a XMLRPC struct. More...

void addParam (long value)
 Add an integer paramater to XMLRPC request. More...

void addMember (const char *name, long value)
 Add an integer member to XMLRPC struct. More...

void addParam (const char *string)
 Add a string paramater to XMLRPC request. More...

void addMember (const char *name, const char *value)
 Add a string member to XMLRPC struct. More...

void endStruct (void)
 Clear a struct. More...

bool Send (const char *resource)
 Complete buffer and send well formed XMLRPC request thru post. More...


Protected Methods

virtual bool Post (const char *resource, const char *msg)
 Used in a derived transport class to deliver the XMLRPC encoded request and return true if successful. More...

void begStruct (void)
 Start member struct. More...


Detailed Description

This class impliments a core XMLRPC service without the underlying transports. XML-RPC service building class.

It is meant to create and parse XMLRPC messages. To use for a fit purpose, one might combine it with URLStream, although this implimentation makes no requirement for http based transport.

Author:
David Sugar <dyfet@ostel.com>


Constructor & Destructor Documentation

ost::XMLRPC::XMLRPC size_t   bufsize
 

Construct XMLRPC workspace.

Parameters:
size   of buffer.

virtual ost::XMLRPC::~XMLRPC   [virtual]
 

Destroy XMLRPC object.


Member Function Documentation

void ost::XMLRPC::Invoke const char *   method
 

Create XMLRPC "method" call in buffer.

Parameters:
name   of method being called.

virtual bool ost::XMLRPC::Post const char *   resource,
const char *   msg
[protected, virtual]
 

Used in a derived transport class to deliver the XMLRPC encoded request and return true if successful.

The Parse method can then be used to decode the reply.

Returns:
true if successful.
Parameters:
resource   to send to (such as url).
well   formed XMLRPC request message.

void ost::XMLRPC::Response bool   fault
 

Create XMLRPC "reply" to a method call.

Parameters:
set   true for fault message.

bool ost::XMLRPC::Send const char *   resource
 

Complete buffer and send well formed XMLRPC request thru post.

Returns:
true if successful.
Parameters:
resource   to send to.

void ost::XMLRPC::addMember const char *   name,
const char *   value
 

Add a string member to XMLRPC struct.

Parameters:
name   of member.
value   of member.

void ost::XMLRPC::addMember const char *   name,
long   value
 

Add an integer member to XMLRPC struct.

Parameters:
name   of member.
value   of member.

void ost::XMLRPC::addMember const char *   name,
bool   value
 

Add bool member to a XMLRPC struct.

Parameters:
name   of member.
value   of member.

void ost::XMLRPC::addParam const char *   string
 

Add a string paramater to XMLRPC request.

Parameters:
string   to add.

void ost::XMLRPC::addParam long   value
 

Add an integer paramater to XMLRPC request.

Parameters:
value   to add.

void ost::XMLRPC::addParam bool   value
 

Add bool param to XMLRPC request.

Parameters:
value   to add.

void ost::XMLRPC::begArray void  
 

Create an array.

void ost::XMLRPC::begStruct void   [protected]
 

Start member struct.

void ost::XMLRPC::endArray void  
 

end an array.

void ost::XMLRPC::endStruct void  
 

Clear a struct.


The documentation for this class was generated from the following file:
Generated at Fri Jan 4 18:51:52 2002 for CommonC++ by doxygen1.2.10 written by Dimitri van Heesch, © 1997-2001