SIPDialogNotification Struct Reference

`#include <handlers.h>`

Inheritance diagram for SIPDialogNotification:

## Data Structures

struct | Participant

## Public Types

enum | States { Terminated, Trying, Proceeding, Early, Confirmed, FirstState = Terminated, LastState = Confirmed }
enum | Events { NoEvent = -1, Cancelled, Rejected, Replaced, LocalBye, RemoteBye, Error, Timeout, FirstEvent = Cancelled, LastEvent = Timeout }
enum | Rendering { RenderingUnknown = -1, NotRenderingMedia, RenderingMedia }

## Public Member Functions

| PCLASSINFO (SIPDialogNotification, PObject)
PString | GetStateName () const
PString | GetEventName () const
| SIPDialogNotification (const PString &entity=PString::Empty())
void | PrintOn (ostream &strm) const

## Static Public Member Functions

static PString | GetStateName (States state)
static PString | GetEventName (Events state)

## Data Fields

PString | m_entity
PString | m_dialogId
PString | m_callId
bool | m_initiator
States | m_state
Events | m_eventType
unsigned | m_eventCode
struct SIPDialogNotification::Participant | m_local
struct SIPDialogNotification::Participant | m_remote

## Friends

States | operator++ (States &state)
States | operator-- (States &state)
Events | operator++ (Events &evt)
Events | operator-- (Events &evt)

## Detailed Description

Information for SIP "dialog" event package notification messages.

## Member Enumeration Documentation

enum SIPDialogNotification::Events

Enumerator
NoEvent |
Cancelled |
Rejected |
Replaced |
LocalBye |
RemoteBye |
Error |
Timeout |
FirstEvent |
LastEvent |

enum SIPDialogNotification::Rendering

Enumerator
RenderingUnknown |
NotRenderingMedia |
RenderingMedia |

enum SIPDialogNotification::States

Enumerator
Terminated |
Trying |
Proceeding |
Early |
Confirmed |
FirstState |
LastState |

## Constructor & Destructor Documentation

SIPDialogNotification::SIPDialogNotification | ( | const PString & | entity = `PString::Empty()` | ) |

## Member Function Documentation

static PString SIPDialogNotification::GetEventName | ( | Events | state | ) |

static

PString SIPDialogNotification::GetEventName | ( |  | ) | const

inline

References GetEventName(), and m_eventType.

Referenced by GetEventName().

static PString SIPDialogNotification::GetStateName | ( | States | state | ) |

static

PString SIPDialogNotification::GetStateName | ( |  | ) | const

inline

References GetStateName(), and m_state.

Referenced by GetStateName().

SIPDialogNotification::PCLASSINFO | ( | SIPDialogNotification | ,
|  | PObject |
| ) |  |

void SIPDialogNotification::PrintOn | ( | ostream & | strm | ) | const

## Friends And Related Function Documentation

States operator++ | ( | States & | state | ) |

friend

Events operator++ | ( | Events & | evt | ) |

friend

States operator-- | ( | States & | state | ) |

friend

Events operator-- | ( | Events & | evt | ) |

friend

## Field Documentation

PString SIPDialogNotification::m_callId

PString SIPDialogNotification::m_dialogId

PString SIPDialogNotification::m_entity

unsigned SIPDialogNotification::m_eventCode

Events SIPDialogNotification::m_eventType

Referenced by GetEventName().

bool SIPDialogNotification::m_initiator

struct SIPDialogNotification::Participant SIPDialogNotification::m_local

struct SIPDialogNotification::Participant SIPDialogNotification::m_remote

States SIPDialogNotification::m_state

Referenced by GetStateName().

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

- handlers.h