Yate
Public Member Functions | Public Attributes

SIPDialog Class Reference

SIP Dialog object. More...

#include <yatesip.h>

Inheritance diagram for SIPDialog:
String GenObject

List of all members.

Public Member Functions

 SIPDialog ()
 SIPDialog (const SIPDialog &original)
 SIPDialog (const SIPMessage &message)
 SIPDialog (const String &callid)
SIPDialogoperator= (const SIPDialog &original)
SIPDialogoperator= (const SIPMessage &message)
SIPDialogoperator= (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 StringfromURI (bool outgoing) const
const StringfromTag (bool outgoing) const
const StringtoURI (bool outgoing) const
const StringtoTag (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:
originalOriginal SIP dialog to copy
SIPDialog ( const SIPMessage message) [explicit]

Constructor from a SIP message

Parameters:
messageSIP message to copy the dialog information from
SIPDialog ( const String callid) [inline, explicit]

Constructor from a Call ID, leaves URIs and tags empty

Parameters:
callidCall ID to insert in the dialog

Member Function Documentation

const String& fromTag ( bool  outgoing) const [inline]

Get the From tag from the dialog

Parameters:
outgoingTrue 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:
outgoingTrue 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:
otherOther dialog to compare to
ignoreURIsTrue 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:
otherOther 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:
otherOther 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:
originalOriginal SIP dialog to copy
Returns:
Reference to this SIP dialog
SIPDialog& operator= ( const SIPMessage message)

Assignment from a SIP message

Parameters:
messageSIP 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:
callidCall 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:
otherOther 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:
otherOther 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:
outgoingTrue 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:
outgoingTrue if getting the URI for an outgoing transaction
Returns:
Reference to the To URI in dialog

Member Data Documentation

Tag parameter of the local URI

Local URI of the dialog

Tag parameter of the remote URI

Remote URI of the dialog


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