SipDialogEvent Class Reference

Container for MIME type application/dialog-info+xml. More...

#include <SipDialogEvent.h>

Inheritance diagram for SipDialogEvent:

Collaboration diagram for SipDialogEvent:

Public Member Functions
====================== Constructors and Destructors
	SipDialogEvent (const char *state, const char *entity)
	Construct an empty body of a dialog event package. More...
	SipDialogEvent (const char *bodyBytes)
	Construct from an existing dialog event package in XML format. More...
virtual	~SipDialogEvent ()
	Destructor that will free up the memory allocated for dialog contents if it is not being deleted. More...
====================== Dialog 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 dialog event. More...
virtual void	getBytes (UtlString *bytes, int *length) const
	Get the serialized string representation of this dialog event. More...
void	setEntity (const char *entity)
void	getEntity (UtlString &entity) const
void	setState (const char *state)
void	getState (UtlString &state) const
====================== Dialog Setting Interfaces
These methods set/get the dialog element.
void	insertDialog (Dialog *dialog)
	Insert a Dialog object. More...
Dialog *	getDialog (UtlString &callId, UtlString &localTag, UtlString &remoteTag)
	Get the Dialog object from the hash table based on the callId. More...
Dialog *	getDialogByCallId (UtlString &callId)
	In the case where a empty SipDialog object is retrieved from the. More...
Dialog *	removeDialog (Dialog *dialog)
	Remove a Dialog object. More...
UtlBoolean	isEmpty ()
	Check whether there is are any dialogs or not. More...
UtlSListIterator *	getDialogIterator ()
	Return an iterator that will retrieve all dialogs in the event. 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 dialog 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/dialog-info+xml.

This class contains all the contents presented in a dialog event package described in draft-ietf-sipping-dialog-package-06.txt (An INVITE Initiated Dialog Event Package for SIP). This class has the methods to construct and manipulate the dialog events in a dialog event package.

Constructor & Destructor Documentation

SipDialogEvent	(	const char *	state,
		const char *	entity
	)

Construct an empty body of a dialog event package.

SipDialogEvent

(

const char *

bodyBytes

)

Construct from an existing dialog event package in XML format.

~SipDialogEvent ( )

virtual

Destructor that will free up the memory allocated for dialog 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 dialog event.

Parameters

bytes	- pointer to the body text of the dialog event will be placed here.
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 dialog event.

Parameters

bytes	- UtlString into which the body text will be copied.
length	- the number of bytes written (not including the null terminator).

Reimplemented from HttpBody.

void setEntity

(

const char *

entity

)

void getEntity

(

UtlString &

entity

)

const

void setState

(

const char *

state

)

void getState

(

UtlString &

state

)

const

void insertDialog

(

Dialog *

dialog

)

Insert a Dialog object.

Dialog * getDialog	(	UtlString &	callId,
		UtlString &	localTag,
		UtlString &	remoteTag
	)

Get the Dialog object from the hash table based on the callId.

Dialog * getDialogByCallId

(

UtlString &

callId

)

In the case where a empty SipDialog object is retrieved from the.

Dialog * removeDialog

(

Dialog *

dialog

)

Remove a Dialog object.

UtlBoolean isEmpty

(

)

Check whether there is are any dialogs or not.

UtlSListIterator * getDialogIterator

(

)

Return an iterator that will retrieve all dialogs in the event.

void parseBody ( const char *  bytes )

protected

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