SIP body type for holding DialogInfo contents (MIME content-type application/dialog-info+xml). More...

#include <DialogInfoContents.hxx>

Inheritance diagram for resip::DialogInfoContents:

Classes
class	Dialog

Public Types
enum	DialogInfoState { Full , Partial , MaxDialogInfoState }

enum	DialogState { Trying = 0 , Proceeding , Early , Confirmed , Terminated , MaxDialogState }

enum	DialogStateEvent { Cancelled = 0 , Rejected , Replaced , LocalBye , RemoteBye , Error , Timeout , MaxOrUnsetDialogStateEvent }

enum	Direction { Initiator = 0 , Recipient , MaxOrUnsetDirection }

typedef std::list< Dialog >	DialogList

Public Member Functions
	RESIP_HeapCount (DialogInfoContents)

	DialogInfoContents (const Mime &contentType)

	DialogInfoContents ()

	DialogInfoContents (const HeaderFieldValue &hfv, const Mime &contentType)

virtual	~DialogInfoContents ()

virtual Contents *	clone () const
	duplicate an DialogInfoContents object

virtual EncodeStream &	encodeParsed (EncodeStream &str) const

virtual void	parse (ParseBuffer &pb)

void	setEncodeIndent (const Data &indent)

void	setEntity (const Uri &entity)

const Uri &	getEntity () const

void	setVersion (uint32_t version)

uint32_t	getVersion () const

void	setDialogInfoState (DialogInfoState dialogInfoState)

DialogInfoState	getDialogInfoState () const

const DialogList &	getDialogs () const

void	addDialog (const Dialog &dialog)

bool	removeDialog (const Data &id)

void	clearDialogs ()

Public Member Functions inherited from resip::Contents
	Contents (const HeaderFieldValue &headerFieldValue, const Mime &contentsType)
	pass Mime instance for parameters

	Contents (const Mime &contentsType)
	Create a contents with a given mime type.

	Contents (const Contents &rhs)
	Copy constructor.

	Contents (const Contents &rhs, HeaderFieldValue::CopyPaddingEnum e)

	Contents (const HeaderFieldValue &headerFieldValue, HeaderFieldValue::CopyPaddingEnum e, const Mime &contentsType)

virtual	~Contents ()

Contents &	operator= (const Contents &rhs)
	Assignment operator.

void	preParseHeaders (ParseBuffer &pb)
	Preforms preparsing on the headers stored in the ParseBuffer pb.

EncodeStream &	encodeHeaders (EncodeStream &str) const
	encodes headers to an output stream

virtual Contents *	getContents ()
	access to wrapped contents (signed, encrypted)

Contents *	getContents (const Mime &)

virtual Data	getBodyData () const

const Mime &	getType () const
	getter for mime type of message

bool	exists (const HeaderBase &headerType) const
	checks to see if a header is present

void	remove (const HeaderBase &headerType)
	removes a header if it is present

bool	exists (const MIME_Header &headerType) const
	checks to see if a MIME header exists

void	remove (const MIME_Header &headerType)
	removes a MIME header if it is present

const H_ContentType::Type &	header (const H_ContentType &headerType) const
	returns the value of the Content-Type header Throws an Contents::Exception if the header doesn't exist.

H_ContentType::Type &	header (const H_ContentType &headerType)
	returns the value of the Content-Type header

const H_ContentDisposition::Type &	header (const H_ContentDisposition &headerType) const
	returns the value of the Content-Disposition header Throws an Contents::Exception if the header doesn't exist.

H_ContentDisposition::Type &	header (const H_ContentDisposition &headerType)
	returns the value of the Content-Disposition header

const H_ContentTransferEncoding::Type &	header (const H_ContentTransferEncoding &headerType) const
	returns the value of the Content-Transfer-Encoding header Throws an Contents::Exception if the header doesn't exist.

H_ContentTransferEncoding::Type &	header (const H_ContentTransferEncoding &headerType)
	returns the value of the Content-Transfer-Encoding header

const H_ContentLanguages::Type &	header (const H_ContentLanguages &headerType) const
	returns the value of the Content-Languages header Throws an Contents::Exception if the header doesn't exist.

H_ContentLanguages::Type &	header (const H_ContentLanguages &headerType)
	returns the value of the Content-Languages header

const H_ContentID::Type &	header (const H_ContentID &headerType) const
	returns the value of the Content-ID MIME header Throws an Contents::Exception if the header doesn't exist.

H_ContentID::Type &	header (const H_ContentID &headerType)
	returns the value of the Content-ID MIME header

const H_ContentDescription::Type &	header (const H_ContentDescription &headerType) const
	returns the Content-Description MIME header Throws an Contents::Exception if the header doesn't exist.

H_ContentDescription::Type &	header (const H_ContentDescription &headerType)
	returns the Content-Description MIME header

int &	version ()
	returns the major version of MIME used by the contents

int &	minorVersion ()
	returns the minor version of MIME used by the contents

void	addBuffer (char *buf)

Public Member Functions inherited from resip::LazyParser
	LazyParser (const HeaderFieldValue &headerFieldValue)

	LazyParser (const char *buf, int length)

	LazyParser (const HeaderFieldValue &headerFieldValue, HeaderFieldValue::CopyPaddingEnum e)

	LazyParser (const LazyParser &rhs)

	LazyParser (const LazyParser &rhs, HeaderFieldValue::CopyPaddingEnum e)

LazyParser &	operator= (const LazyParser &rhs)

virtual	~LazyParser ()

EncodeStream &	encode (EncodeStream &str) const
	Encodes this element to a stream, in the fashion it should be represented on the wire.

bool	isParsed () const
	Returns true iff a parse has been attempted.

HeaderFieldValue &	getHeaderField ()

void	checkParsed () const

void	checkParsed ()

void	doParse () const

void	markDirty () const

bool	isWellFormed () const
	Returns true iff this element was parsed successfully, according to the implementation of parse().

Static Public Member Functions
static const Mime &	getStaticType ()

static bool	init ()

static const char *	dialogInfoStateToString (const DialogInfoState &dialogInfoState)

static DialogInfoState	dialogInfoStateStringToEnum (const Data &dialogInfoStateString)

static const char *	dialogStateToString (const DialogState &dialogState)

static DialogState	dialogStateStringToEnum (const Data &dialogStateString)

static const char *	dialogStateEventToString (const DialogStateEvent &dialogStateEvent)

static DialogStateEvent	dialogStateEventStringToEnum (const Data &dialogStateEventString)

static const char *	directionToString (const Direction &direction)

static Direction	directionStringToEnum (const Data &directionString)

static bool	compareTag (const Data &tagName, const Data &compareToTagNoPrefix, const Data &namespacePrefix)

Static Public Member Functions inherited from resip::Contents
static Contents *	createContents (const Mime &contentType, const Data &contents)
	factory method to create a Contents object from a mime type and a payload

Static Public Attributes
static const DialogInfoContents	Empty

Additional Inherited Members
Protected Member Functions inherited from resip::Contents
void	clear ()

void	init ()

void	init (const Contents &orig)

void	freeMem ()

virtual const Data &	errorContext () const

Protected Member Functions inherited from resip::LazyParser
	LazyParser ()

void	clear ()

Protected Attributes inherited from resip::Contents
Mime	mType

H_ContentDisposition::Type *	mDisposition

H_ContentTransferEncoding::Type *	mTransferEncoding

H_ContentLanguages::Type *	mLanguages

Token *	mId

H_ContentDescription::Type *	mDescription

StringCategory *	mLength

int	mVersion

int	mMinorVersion

std::vector< char * >	mBufferList

Detailed Description

SIP body type for holding DialogInfo contents (MIME content-type application/dialog-info+xml).

Definition at line 21 of file DialogInfoContents.hxx.

Member Typedef Documentation

◆ DialogList

typedef std::list<Dialog> resip::DialogInfoContents::DialogList

Definition at line 275 of file DialogInfoContents.hxx.

Member Enumeration Documentation

◆ DialogInfoState

enum resip::DialogInfoContents::DialogInfoState

Enumerator
Full
Partial
MaxDialogInfoState

Definition at line 25 of file DialogInfoContents.hxx.

◆ DialogState

enum resip::DialogInfoContents::DialogState

Enumerator
Trying
Proceeding
Early
Confirmed
Terminated
MaxDialogState

Definition at line 33 of file DialogInfoContents.hxx.

◆ DialogStateEvent

enum resip::DialogInfoContents::DialogStateEvent

Enumerator
Cancelled
Rejected
Replaced
LocalBye
RemoteBye
Error
Timeout
MaxOrUnsetDialogStateEvent

Definition at line 44 of file DialogInfoContents.hxx.

◆ Direction

enum resip::DialogInfoContents::Direction

Enumerator
Initiator
Recipient
MaxOrUnsetDirection

Definition at line 57 of file DialogInfoContents.hxx.

Constructor & Destructor Documentation

◆ DialogInfoContents() [1/3]

DialogInfoContents::DialogInfoContents ( const Mime & contentType )

Definition at line 162 of file DialogInfoContents.cxx.

◆ DialogInfoContents() [2/3]

DialogInfoContents::DialogInfoContents ( )

Definition at line 157 of file DialogInfoContents.cxx.

◆ DialogInfoContents() [3/3]

DialogInfoContents::DialogInfoContents	(	const HeaderFieldValue &	hfv,
		const Mime &	contentType
	)

Definition at line 167 of file DialogInfoContents.cxx.

◆ ~DialogInfoContents()

DialogInfoContents::~DialogInfoContents ( )

virtual

Definition at line 172 of file DialogInfoContents.cxx.

Member Function Documentation

◆ addDialog()

void DialogInfoContents::addDialog ( const Dialog & dialog )

Definition at line 927 of file DialogInfoContents.cxx.

◆ clearDialogs()

void resip::DialogInfoContents::clearDialogs ( )

inline

Definition at line 279 of file DialogInfoContents.hxx.

◆ clone()

Contents * DialogInfoContents::clone ( ) const

virtual

duplicate an DialogInfoContents object

Returns: pointer to a new DialogInfoContents object

Implements resip::Contents.

Definition at line 177 of file DialogInfoContents.cxx.

◆ compareTag()

bool DialogInfoContents::compareTag	(	const Data &	tagName,
		const Data &	compareToTagNoPrefix,
		const Data &	namespacePrefix
	)

static

Definition at line 144 of file DialogInfoContents.cxx.

◆ dialogInfoStateStringToEnum()

DialogInfoContents::DialogInfoState DialogInfoContents::dialogInfoStateStringToEnum ( const Data & dialogInfoStateString )

static

Definition at line 48 of file DialogInfoContents.cxx.

◆ dialogInfoStateToString()

const char * DialogInfoContents::dialogInfoStateToString ( const DialogInfoState & dialogInfoState )

static

Definition at line 42 of file DialogInfoContents.cxx.

◆ dialogStateEventStringToEnum()

DialogInfoContents::DialogStateEvent DialogInfoContents::dialogStateEventStringToEnum ( const Data & dialogStateEventString )

static

Definition at line 106 of file DialogInfoContents.cxx.

◆ dialogStateEventToString()

const char * DialogInfoContents::dialogStateEventToString ( const DialogStateEvent & dialogStateEvent )

static

Definition at line 100 of file DialogInfoContents.cxx.

◆ dialogStateStringToEnum()

DialogInfoContents::DialogState DialogInfoContents::dialogStateStringToEnum ( const Data & dialogStateString )

static

Definition at line 76 of file DialogInfoContents.cxx.

◆ dialogStateToString()

const char * DialogInfoContents::dialogStateToString ( const DialogState & dialogState )

static

Definition at line 70 of file DialogInfoContents.cxx.

◆ directionStringToEnum()

DialogInfoContents::Direction DialogInfoContents::directionStringToEnum ( const Data & directionString )

static

Definition at line 131 of file DialogInfoContents.cxx.

◆ directionToString()

const char * DialogInfoContents::directionToString ( const Direction & direction )

static

Definition at line 125 of file DialogInfoContents.cxx.

◆ encodeParsed()

EncodeStream & DialogInfoContents::encodeParsed ( EncodeStream & str ) const

virtual

Implements resip::LazyParser.

Definition at line 190 of file DialogInfoContents.cxx.

◆ getDialogInfoState()

DialogInfoState resip::DialogInfoContents::getDialogInfoState ( ) const

inline

Definition at line 92 of file DialogInfoContents.hxx.

◆ getDialogs()

const DialogList & resip::DialogInfoContents::getDialogs ( ) const

inline

Definition at line 276 of file DialogInfoContents.hxx.

◆ getEntity()

const Uri & resip::DialogInfoContents::getEntity ( ) const

inline

Definition at line 86 of file DialogInfoContents.hxx.

◆ getStaticType()

const Mime & DialogInfoContents::getStaticType ( )

static

Definition at line 183 of file DialogInfoContents.cxx.

◆ getVersion()

uint32_t resip::DialogInfoContents::getVersion ( ) const

inline

Definition at line 89 of file DialogInfoContents.hxx.

◆ init()

bool DialogInfoContents::init ( )

static

Definition at line 28 of file DialogInfoContents.cxx.

◆ parse()

void DialogInfoContents::parse ( ParseBuffer & pb )

virtual

Implements resip::LazyParser.

Definition at line 501 of file DialogInfoContents.cxx.

◆ removeDialog()

bool DialogInfoContents::removeDialog ( const Data & id )

Definition at line 936 of file DialogInfoContents.cxx.

◆ RESIP_HeapCount()

resip::DialogInfoContents::RESIP_HeapCount ( DialogInfoContents )

◆ setDialogInfoState()

void resip::DialogInfoContents::setDialogInfoState ( DialogInfoState dialogInfoState )

inline

Definition at line 91 of file DialogInfoContents.hxx.

◆ setEncodeIndent()

void resip::DialogInfoContents::setEncodeIndent ( const Data & indent )

inline

Definition at line 82 of file DialogInfoContents.hxx.

◆ setEntity()

void resip::DialogInfoContents::setEntity ( const Uri & entity )

inline

Definition at line 85 of file DialogInfoContents.hxx.

◆ setVersion()

void resip::DialogInfoContents::setVersion ( uint32_t version )

inline

Definition at line 88 of file DialogInfoContents.hxx.

Member Data Documentation

◆ Empty

const DialogInfoContents DialogInfoContents::Empty

static

Definition at line 65 of file DialogInfoContents.hxx.

The documentation for this class was generated from the following files:

resip/stack/DialogInfoContents.hxx
resip/stack/DialogInfoContents.cxx

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DialogList

Member Enumeration Documentation

◆ DialogInfoState

◆ DialogState

◆ DialogStateEvent

◆ Direction

Constructor & Destructor Documentation

◆ DialogInfoContents() [1/3]

◆ DialogInfoContents() [2/3]

◆ DialogInfoContents() [3/3]

◆ ~DialogInfoContents()

Member Function Documentation

◆ addDialog()

◆ clearDialogs()

◆ clone()

◆ compareTag()

◆ dialogInfoStateStringToEnum()

◆ dialogInfoStateToString()

◆ dialogStateEventStringToEnum()

◆ dialogStateEventToString()

◆ dialogStateStringToEnum()

◆ dialogStateToString()

◆ directionStringToEnum()

◆ directionToString()

◆ encodeParsed()

◆ getDialogInfoState()

◆ getDialogs()

◆ getEntity()

◆ getStaticType()

◆ getVersion()

◆ init()

◆ parse()

◆ removeDialog()

◆ RESIP_HeapCount()

◆ setDialogInfoState()

◆ setEncodeIndent()

◆ setEntity()

◆ setVersion()

Member Data Documentation

◆ Empty