SIPX_SUBSTATUS_INFO Struct Reference

An SUBSTATUS event informs that application layer of the status of an outbound SUBSCRIPTION requests;. More...

#include <sipXtapiEvents.h>

Public Attributes
size_t	nSize
	The size of this structure in bytes. More...
SIPX_SUB	hSub
	A handle to the subscription to which this state change occurred. More...
SIPX_SUBSCRIPTION_STATE	state
	Enum state value indicating the current state of the subscription. More...
SIPX_SUBSCRIPTION_CAUSE	cause
	Enum cause for the state change in this event. More...
const char *	szSubServerUserAgent
	The User Agent header field value from the SIP SUBSCRIBE response (may be NULL) More...

Detailed Description

An SUBSTATUS event informs that application layer of the status of an outbound SUBSCRIPTION requests;.

This information is passed as part of the sipXtapi callback mechanism. Based on the SIPX_EVENT_CATEGORY, the application developer should cast the pInfo member of your callback to the appropriate structure.

See also

SIPX_EVENT_CALLBACK_PROC

SIPX_EVENT_CATEGORY

Member Data Documentation

size_t nSize

The size of this structure in bytes.

SIPX_SUB hSub

A handle to the subscription to which this state change occurred.

SIPX_SUBSCRIPTION_STATE state

Enum state value indicating the current state of the subscription.

SIPX_SUBSCRIPTION_CAUSE cause

Enum cause for the state change in this event.

const char* szSubServerUserAgent

The User Agent header field value from the SIP SUBSCRIBE response (may be NULL)