sipxtacklib  Version 3.3
Public Member Functions | List of all members
XmlRpcBody Class Reference

This class contains all the contents presented in a XML-RPC body. More...

#include <XmlRpcBody.h>

Inheritance diagram for XmlRpcBody:
Inheritance graph
[legend]
Collaboration diagram for XmlRpcBody:
Collaboration graph
[legend]

Public Member Functions

 XmlRpcBody ()
 Construct an empty body of a XML-RPC. More...
 
virtual ~XmlRpcBody ()
 Destructor. More...
 
void append (const char *string)
 Append the string to the body. More...
 
virtual int getLength () const
 Get the string length of this object. More...
 
virtual void getBytes (const char **bytes, int *length) const
 Get the serialized char representation of this body. More...
 
virtual void getBytes (UtlString *bytes, int *length) const
 Get the serialized string representation of this body. More...
 
bool addValue (UtlContainable *value)
 Add a value to the XML-RPC content. More...
 
bool addArray (UtlSList *array)
 Add an array to the XML-RPC content. More...
 
bool addStruct (UtlHashMap *members)
 Add a struct to the XML-RPC content. More...
 
- Public Member Functions inherited from HttpBody
 HttpBody (const char *bytes=NULL, int length=-1, const char *contentType=NULL)
 
 HttpBody (const char *contentType)
 
 HttpBody (const HttpBody &rHttpBody)
 
virtual ~HttpBody ()
 
HttpBodyoperator= (const HttpBody &rhs)
 
void appendBodyPart (const HttpBody &body, const UtlDList &parameters)
 Append a multipart body part to an existing multiparty body. More...
 
virtual const char * getBytes () const
 
UtlBoolean getMultipartBytes (int partIndex, const char **bytes, int *length, int *start) const
 
const MimeBodyPartgetMultipart (int partIndex) const
 
int getMultipartCount () const
 
BodyClassTypes getClassType () const
 
const char * getMultipartBoundary () const
 Get the multipart boundary string. More...
 
const char * getContentType () const
 Get the content type string. More...
 
UtlBoolean isMultipart () const
 

Additional Inherited Members

- Public Types inherited from HttpBody
enum  BodyClassTypes {
  UNKNOWN_BODY_CLASS = 0,
  HTTP_BODY_CLASS,
  SMIME_BODY_CLASS,
  SDP_BODY_CLASS,
  PIDF_BODY_CLASS,
  DIALOG_EVENT_BODY_CLASS
}
 
- Static Public Member Functions inherited from HttpBody
static HttpBodycopyBody (const HttpBody &sourceBody)
 Copy the source HttpBody using the correct derived class constructor. More...
 
static HttpBodycreateBody (const char *bodyBytes, int bodyBytesLength, const char *contentType, const char *contentEncoding)
 Pseudo body factory. More...
 
- Protected Attributes inherited from HttpBody
int bodyLength
 
UtlString mBody
 
UtlString mMultipartBoundary
 
int mBodyPartCount
 
MimeBodyPartmpBodyParts [MAX_HTTP_BODY_PARTS]
 
BodyClassTypes mClassType
 

Detailed Description

This class contains all the contents presented in a XML-RPC body.

This class has the methods to construct a XML-RPC body. It is only used by XmlRpcRequest and XmlRpcResponse classes.

Constructor & Destructor Documentation

Construct an empty body of a XML-RPC.

~XmlRpcBody ( )
virtual

Destructor.

Member Function Documentation

void append ( const char *  string)

Append the string to the body.

int getLength ( ) const
virtual

Get the string length of this object.

Reimplemented from HttpBody.

void getBytes ( const char **  bytes,
int *  length 
) const
virtual

Get the serialized char representation of this body.

Parameters
bytesbuffer space where the body content is written, null terminated
lengththe number of bytes written (not including the null terminator

Reimplemented from HttpBody.

void getBytes ( UtlString *  bytes,
int *  length 
) const
virtual

Get the serialized string representation of this body.

Parameters
bytesbuffer space where the body content is written, null terminated
lengththe number of bytes written (not including the null terminator

Reimplemented from HttpBody.

bool addValue ( UtlContainable *  value)

Add a value to the XML-RPC content.

bool addArray ( UtlSList *  array)

Add an array to the XML-RPC content.

array of elements

bool addStruct ( UtlHashMap *  members)

Add a struct to the XML-RPC content.

struct of members


sipXtackLib home page