OPAL  Version 3.18.8
OpalProtocolMessage Struct Reference

#include <opal.h>

Collaboration diagram for OpalProtocolMessage:

Data Fields

const char * m_protocol
 Protocol this message is from, e.g. "sip". More...
 
const char * m_callToken
 Call token for context of the message. More...
 
const char * m_identifier
 Protocol specific indentifier for what this message is about. More...
 
const void * m_payload
 Extra protocol and identifier specific data. More...
 
unsigned m_size
 Size of the above data. More...
 
unsigned m_extraCount
 
const OpalMIMEm_extras
 

Detailed Description

Indication of a protocol specific message. Sent by OpalIndProtocolMessage message.

In the case of a SIP INFO message, the protocol message identifier (m_identifier) is the string "INFO\t" followed by the "Info-Package" header for that message.

In the case if a SIP re-INVITE, the identifier will be "INVITE" and the payload will be the SDP received, if any.

In all cases, if multi-part mime was received, that information is placed into the "extras" fields, similar to OpalParamSetUpCall and OpalStatusIncomingCall.

Field Documentation

const char* OpalProtocolMessage::m_callToken

Call token for context of the message.

unsigned OpalProtocolMessage::m_extraCount
Count of extra information items in m_extras. This fields contains any

extra information that is available about the outgoing call. It will typically be protocol specific. For example, for SIP, this is the multi-part MIME data that may be in the re-INVITE.

const OpalMIME* OpalProtocolMessage::m_extras

Data for each extra piece of extra information.

const char* OpalProtocolMessage::m_identifier

Protocol specific indentifier for what this message is about.

const void* OpalProtocolMessage::m_payload

Extra protocol and identifier specific data.

const char* OpalProtocolMessage::m_protocol

Protocol this message is from, e.g. "sip".

unsigned OpalProtocolMessage::m_size

Size of the above data.


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