SIPDialog Class Reference
SIP Dialog object.
More...
#include <yatesip.h>
List of all members.
Detailed Description
SIP Dialog object.
A class to store information required to identify a dialog
Constructor & Destructor Documentation
Default constructor, build an empty SIP dialog
Copy constructor
- Parameters:
-
| original | Original SIP dialog to copy |
Constructor from a SIP message
- Parameters:
-
| message | SIP message to copy the dialog information from |
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)
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.
Assignment from a SIP message
- Parameters:
-
| message | SIP message to copy the dialog information from |
- Returns:
- Reference to this SIP dialog
Assignment from another dialog
- Parameters:
-
| original | Original SIP dialog to copy |
- Returns:
- Reference to this SIP dialog
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
Tag parameter of the local URI
Tag parameter of the remote URI
The documentation for this class was generated from the following file: