class SIPDialog

SIP Dialog object. More...

Full nameTelEngine::SIPDialog
Definition#include <libs/ysip/yatesip.h>
InheritsTelEngine::String [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Members

Protected Members


Detailed Description

A class to store information required to identify a dialog

inline  SIPDialog ()

SIPDialog

Default constructor, build an empty SIP dialog

 SIPDialog (const SIPDialog& original)

SIPDialog

Copy constructor

Parameters:
originalOriginal SIP dialog to copy

explicit  SIPDialog (const SIPMessage& message)

SIPDialog

Constructor from a SIP message

Parameters:
messageSIP message to copy the dialog information from

inline explicit  SIPDialog (const String& callid)

SIPDialog

Constructor from a Call ID, leaves URIs and tags empty

Parameters:
callidCall ID to insert in the dialog

SIPDialog&  operator= (const SIPDialog& original)

operator=

Assignment from another dialog

Parameters:
originalOriginal SIP dialog to copy

Returns: Reference to this SIP dialog

Reimplemented from String.

SIPDialog&  operator= (const SIPMessage& message)

operator=

Assignment from a SIP message

Parameters:
messageSIP message to copy the dialog information from

Returns: Reference to this SIP dialog

Reimplemented from String.

SIPDialog&  operator= (const String& callid)

operator=

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  matches (const SIPDialog& other, bool ignoreURIs)

matches

[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

Reimplemented from String.

inline bool  operator== (const SIPDialog& other)

operator==

[const]

Dialog equality comparation, suitable for RFC 2543

Parameters:
otherOther dialog to compare to

Returns: True if the two dialogs are equal

Reimplemented from String.

inline bool  operator!= (const SIPDialog& other)

operator!=

[const]

Dialog inequality comparation, suitable for RFC 2543

Parameters:
otherOther dialog to compare to

Returns: True if the two dialogs are different

Reimplemented from String.

inline bool  operator&= (const SIPDialog& other)

operator&=

[const]

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)

Reimplemented from String.

inline bool  operator|= (const SIPDialog& other)

operator|=

[const]

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)

Reimplemented from String.

inline const String&  fromURI (bool outgoing)

fromURI

[const]

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

inline const String&  fromTag (bool outgoing)

fromTag

[const]

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

inline const String&  toURI (bool outgoing)

toURI

[const]

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

inline const String&  toTag (bool outgoing)

toTag

[const]

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

inline SIPSequence*  getSequence ()

getSequence

[const]

Get the Command Sequence Number generator

Returns: Pointer to the CSeq generator of this dialog

inline void  setSequence (SIPSequence* seq)

setSequence

Set the Command Sequence Number generator

Parameters:
seqPointer to the new CSeq generator of this dialog

void  setCSeq (int32_t cseq)

setCSeq

Set a new Command Sequence generator

Parameters:
cseqNew sequence number to start from

inline int32_t  getLastCSeq ()

getLastCSeq

[const]

Get the last number generated by this dialog

Returns: Last generated CSeq value between 0 and 2^31-1, negative if no generator

inline int32_t  getNextCSeq ()

getNextCSeq

Create a CSeq value suitable for use in a new request

Returns: New CSeq value between 1 and 2^31-1, negative if no generator

inline bool  adjustCSeq (int cseq)

adjustCSeq

Adjust the last seen remote CSeq

Parameters:
cseqRemote sequence number

Returns: True if remote sequence was adjusted

inline bool  adjustCSeq (const SIPMessage* message)

adjustCSeq

Adjust the last seen remote CSeq from a SIP message

Parameters:
messagePointer to received SIP message

Returns: True if remote sequence was adjusted

String localURI

localURI

String localTag

localTag

String remoteURI

remoteURI

String remoteTag

remoteTag

int remoteCSeq

remoteCSeq

RefPointer m_seq

m_seq

[protected]


Generated by: paulc on bussard on Thu Jul 24 18:41:02 2014, using kdoc 2.0a54.