SIPDialog Class Reference

SIP Dialog object. More...

#include <yatesip.h>

Inheritance diagram for SIPDialog:

List of all members.

Public Member Functions
	SIPDialog ()
	SIPDialog (const SIPDialog &original)
	SIPDialog (const SIPMessage &message)
	SIPDialog (const String &callid)
SIPDialog &	operator= (const SIPDialog &original)
SIPDialog &	operator= (const SIPMessage &message)
SIPDialog &	operator= (const String &callid)
bool	matches (const SIPDialog &other, bool ignoreURIs) const
bool	operator== (const SIPDialog &other) const
bool	operator!= (const SIPDialog &other) const
bool	operator&= (const SIPDialog &other) const
bool	operator|= (const SIPDialog &other) const
const String &	fromURI (bool outgoing) const
const String &	fromTag (bool outgoing) const
const String &	toURI (bool outgoing) const
const String &	toTag (bool outgoing) const
Public Attributes
String	localURI
String	localTag
String	remoteURI
String	remoteTag

---

Detailed Description

SIP Dialog object.

A class to store information required to identify a dialog

---

Constructor & Destructor Documentation

SIPDialog

(

)

Default constructor, build an empty SIP dialog

SIPDialog

(

const SIPDialog &

original

)

Copy constructor

Parameters:

original

Original SIP dialog to copy

SIPDialog

(

const SIPMessage &

message

)

[explicit]

Constructor from a SIP message

Parameters:

message

SIP message to copy the dialog information from

SIPDialog

(

const String &

callid

)

[inline, explicit]

Constructor from a Call ID, leaves URIs and tags empty

Parameters:

callid

Call ID to insert in the dialog

---

Member Function Documentation

const String& fromTag

(

bool

outgoing

)

const [inline]

Get the From tag from the dialog

Parameters:

outgoing

True if getting the tag for an outgoing transaction

Returns:

Reference to the From URI tag in dialog

const String& fromURI

(

bool

outgoing

)

const [inline]

Get the From URI from the dialog

Parameters:

outgoing

True if getting the URI for an outgoing transaction

Returns:

Reference to the From URI in dialog

bool matches	(	const SIPDialog &	other,
		bool	ignoreURIs
	)		const

SIP dialog matching check

Parameters:

other	Other dialog to compare to
ignoreURIs	True to ignore local and remote URIs when comparing

Returns:

True if the two dialogs match

bool operator!=

(

const SIPDialog &

other

)

const [inline]

Dialog inequality comparation, suitable for RFC 2543

Parameters:

other

Other dialog to compare to

Returns:

True if the two dialogs are different

bool operator&=

(

const SIPDialog &

other

)

const [inline]

Dialog equality comparation, suitable for RFC 3261

Parameters:

other

Other dialog to compare to

Returns:

True if the two dialogs match (ignoring local and remote URIs)

SIPDialog& operator=

(

const SIPDialog &

original

)

Assignment from another dialog

Parameters:

original

Original SIP dialog to copy

Returns:

Reference to this SIP dialog

SIPDialog& operator=

(

const SIPMessage &

message

)

Assignment from a SIP message

Parameters:

message

SIP message to copy the dialog information from

Returns:

Reference to this SIP dialog

SIPDialog& operator=

(

const String &

callid

)

Assignment from a Call ID, URIs and tags are cleared

Parameters:

callid

Call ID to copy to the dialog

Returns:

Reference to this SIP dialog

Reimplemented from String.

bool operator==

(

const SIPDialog &

other

)

const [inline]

Dialog equality comparation, suitable for RFC 2543

Parameters:

other

Other dialog to compare to

Returns:

True if the two dialogs are equal

bool operator|=

(

const SIPDialog &

other

)

const [inline]

Dialog inequality comparation, suitable for RFC 3261

Parameters:

other

Other dialog to compare to

Returns:

True if the two dialogs do not match (ignoring local and remote URIs)

const String& toTag

(

bool

outgoing

)

const [inline]

Get the To tag from the dialog

Parameters:

outgoing

True if getting the tag for an outgoing transaction

Returns:

Reference to the To URI tag in dialog

const String& toURI

(

bool

outgoing

)

const [inline]

Get the To URI from the dialog

Parameters:

outgoing

True if getting the URI for an outgoing transaction

Returns:

Reference to the To URI in dialog

---

Member Data Documentation

String localTag

Tag parameter of the local URI

String localURI

Local URI of the dialog

String remoteTag

Tag parameter of the remote URI

String remoteURI

Remote URI of the dialog

---

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

• yatesip.h