logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

ost::XMLRPC - This class impliments a core XMLRPC service without the underlying transports.

Author

       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++                                    Sun Dec 27 2020                                  ost::XMLRPC(3)

Constructor & Destructor Documentation

ost::XMLRPC::XMLRPC(size_tbufferSize=512)
       Construct XMLRPC workspace.

       ParametersbufferSize size of buffer when using old C++ strstreams. When the newer stringstream (<sstream>) is
           available, this parameter is silently ignored.

   virtualost::XMLRPC::~XMLRPC()[virtual]
       Destroy XMLRPC object.

Detailed Description

       This class impliments a core XMLRPC service without the underlying transports.

       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

       XML-RPC service building class

Member Function Documentation

voidost::XMLRPC::addMember(constchar*name,boolvalue)
       Add bool member to a XMLRPC struct.

       Parametersname of member.
           value of member.

   voidost::XMLRPC::addMember(constchar*name,constchar*value)
       Add a string member to XMLRPC struct.

       Parametersname of member.
           value of member.

   voidost::XMLRPC::addMember(constchar*name,longvalue)
       Add an integer member to XMLRPC struct.

       Parametersname of member.
           value of member.

   voidost::XMLRPC::addParam(boolvalue)
       Add bool param to XMLRPC request.

       Parametersvalue to add.

   voidost::XMLRPC::addParam(constchar*string)
       Add a string paramater to XMLRPC request.

       Parametersstring to add.

   voidost::XMLRPC::addParam(longvalue)
       Add an integer paramater to XMLRPC request.

       Parametersvalue to add.

   voidost::XMLRPC::begArray(void)
       Create an array.

   voidost::XMLRPC::begStruct(void)[protected]
       Start member struct.

   voidost::XMLRPC::endArray(void)
       end an array.

   voidost::XMLRPC::endStruct(void)
       Clear a struct.

   voidost::XMLRPC::invoke(constchar*method)
       Create XMLRPC 'method' call in buffer.

       Parametersmethod name of method being called.

   virtualboolost::XMLRPC::post(constchar*resource,constchar*msg)[protected],[purevirtual]
       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.

       Parametersresource to send to (such as url).
           msg well formed XMLRPC request message.

   voidost::XMLRPC::response(boolfault)
       Create XMLRPC 'reply' to a method call.

       Parametersfault set true for fault message.

   boolost::XMLRPC::send(constchar*resource)
       Complete buffer and send well formed XMLRPC request thru post.

       Returns
           true if successful.

       Parametersresource to send to.

Name

       ost::XMLRPC - This class impliments a core XMLRPC service without the underlying transports.

Synopsis

       #include <xml.h>

       Inherits ost::XMLStream.

   PublicMemberFunctionsXMLRPC (size_t bufferSize=512)
           Construct XMLRPC workspace.
       virtual ~XMLRPC ()
           Destroy XMLRPC object.
       void begArray (void)
           Create an array.
       void endArray (void)
           end an array.
       void invoke (const char *method)
           Create XMLRPC 'method' call in buffer.
       void response (bool fault)
           Create XMLRPC 'reply' to a method call.
       void addParam (bool value)
           Add bool param to XMLRPC request.
       void addMember (const char *name, bool value)
           Add bool member to a XMLRPC struct.
       void addParam (long value)
           Add an integer paramater to XMLRPC request.
       void addMember (const char *name, long value)
           Add an integer member to XMLRPC struct.
       void addParam (const char *string)
           Add a string paramater to XMLRPC request.
       void addMember (const char *name, const char *value)
           Add a string member to XMLRPC struct.
       void endStruct (void)
           Clear a struct.
       bool send (const char *resource)
           Complete buffer and send well formed XMLRPC request thru post.

   ProtectedMemberFunctions
       virtual bool post (const char *resource, const char *msg)=0
           Used in a derived transport class to deliver the XMLRPC encoded request and return true if
           successful.
       void begStruct (void)
           Start member struct.

See Also