SipPresenceEvent Class Reference

Container for MIME type application/pidf+xml. More...

#include <SipPresenceEvent.h>

Inheritance diagram for SipPresenceEvent:

Collaboration diagram for SipPresenceEvent:

Public Member Functions
====================== Constructors and Destructors
	SipPresenceEvent (const char *entity, const char *bodyBytes=NULL)
	Construct an empty package or one from an existing presence event package in the xml format. More...
virtual	~SipPresenceEvent ()
	Destructor that will free up the memory allocated for presence contents if it is not being deleted. More...
====================== Presence Event Serialization Interfaces
void	buildBody () const
	Build the body of this object. 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 presence event. More...
virtual void	getBytes (UtlString *bytes, int *length) const
	Get the serialized string representation of this presence event. More...
====================== Tuple Setting Interfaces
These methods set/get the tuple element.
void	insertTuple (Tuple *tuple)
	Insert a Tuple object to the hash table. More...
Tuple *	getTuple (UtlString &tupleId)
	Get the Tuple object based on the tupleId. More...
Tuple *	removeTuple (Tuple *tuple)
	Remove the Tuple object. More...
UtlBoolean	isEmpty ()
	Check whether there is any Tuple or not. 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 ()
HttpBody &	operator= (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 MimeBodyPart *	getMultipart (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

Protected Member Functions
void	parseBody (const char *bytes)
	Parse an existing tuple event package from xml format into the internal representation. More...

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 HttpBody *	copyBody (const HttpBody &sourceBody)
	Copy the source HttpBody using the correct derived class constructor. More...
static HttpBody *	createBody (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
MimeBodyPart *	mpBodyParts [MAX_HTTP_BODY_PARTS]
BodyClassTypes	mClassType

Detailed Description

Container for MIME type application/pidf+xml.

This class contains all the contents presented in a presence event package described in RFC 3863. This class has the methods to construct and manipulate the presence events in a presence event package.

Constructor & Destructor Documentation

SipPresenceEvent	(	const char *	entity,
		const char *	bodyBytes = NULL
	)

Construct an empty package or one from an existing presence event package in the xml format.

~SipPresenceEvent ( )

virtual

Destructor that will free up the memory allocated for presence contents if it is not being deleted.

Member Function Documentation

void buildBody

(

)

const

Build the body of this object.

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 presence event.

Parameters

bytes	- buffer space where the presence event is written, null terminated.
length	- the 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 presence event.

Parameters

bytes	- buffer space where the presence event is written, null terminated.
length	- the number of bytes written (not including the null terminator).

Reimplemented from HttpBody.

void insertTuple

(

Tuple *

tuple

)

Insert a Tuple object to the hash table.

Tuple * getTuple

(

UtlString &

tupleId

)

Get the Tuple object based on the tupleId.

Tuple * removeTuple

(

Tuple *

tuple

)

Remove the Tuple object.

UtlBoolean isEmpty

(

)

Check whether there is any Tuple or not.

void parseBody ( const char *  bytes )

protected

Parse an existing tuple event package from xml format into the internal representation.