OPAL  Version 3.10.10
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

◆ Events

Enumerator
NoEvent 
Cancelled 
Rejected 
Replaced 
LocalBye 
RemoteBye 
Error 
Timeout 
FirstEvent 
LastEvent 

◆ Rendering

Enumerator
RenderingUnknown 
NotRenderingMedia 
RenderingMedia 

◆ States

Enumerator
Terminated 
Trying 
Proceeding 
Early 
Confirmed 
FirstState 
LastState 

Constructor & Destructor Documentation

◆ SIPDialogNotification()

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

Member Function Documentation

◆ GetEventName() [1/2]

static PString SIPDialogNotification::GetEventName ( Events  state)
static

◆ GetEventName() [2/2]

PString SIPDialogNotification::GetEventName ( ) const
inline

References GetEventName().

Referenced by GetEventName().

◆ GetStateName() [1/2]

static PString SIPDialogNotification::GetStateName ( States  state)
static

◆ GetStateName() [2/2]

PString SIPDialogNotification::GetStateName ( ) const
inline

References GetStateName(), and SIPHandler::m_state.

Referenced by GetStateName().

◆ PCLASSINFO()

SIPDialogNotification::PCLASSINFO ( SIPDialogNotification  ,
PObject   
)

◆ PrintOn()

void SIPDialogNotification::PrintOn ( ostream &  strm) const

Friends And Related Function Documentation

◆ operator++ [1/2]

States operator++ ( States state)
friend

◆ operator++ [2/2]

Events operator++ ( Events evt)
friend

◆ operator-- [1/2]

States operator-- ( States state)
friend

◆ operator-- [2/2]

Events operator-- ( Events evt)
friend

Field Documentation

◆ m_callId

PString SIPDialogNotification::m_callId

◆ m_dialogId

PString SIPDialogNotification::m_dialogId

◆ m_entity

PString SIPDialogNotification::m_entity

◆ m_eventCode

unsigned SIPDialogNotification::m_eventCode

◆ m_eventType

Events SIPDialogNotification::m_eventType

◆ m_initiator

bool SIPDialogNotification::m_initiator

◆ m_local

struct SIPDialogNotification::Participant SIPDialogNotification::m_local

◆ m_remote

struct SIPDialogNotification::Participant SIPDialogNotification::m_remote

◆ m_state

States SIPDialogNotification::m_state

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