SUBSCRIBE_RESULTS

 

The address of this structure passed back to application space when the media engine's event subscription mechanism is active. When applications receive this information, it represents the results of events subscriptions that were sent to targets you previously specified. In other words, the media engine tried to subscribe to events offered by other SIP devices/targets and this information gives us the result of the subscribe operation.

For further information, see the following events that your application can process: SipSubscriptionTrying, SipSubscriptionMemoryError, SipSubscriptionSuccess, SipSubscriptionTimeOut, or SipSubscriptionNotAccepted.


 

typedef struct

{

EVENT_SUBSCRIBE_HANDLE EventSubscribeHandle;

char *pLocalPhoneName;

char *pNameOfEventServer;

char *pDestinationAddress;

int DestinationPort;

char *pEventName;
char *pEventParameter;

DWORD SubscriptionIntervalSeconds;

TELEPHONY_RETURN_VALUE SipStatus;

int SipResponseCode;

 

}SUBSCRIBE_RESULTS;

 

 

 

Members:

 

EventSubscribeHandle

The event subscription handle.

 

pLocalPhoneName

This member points to a string that is the name of your local phone. The local phone name is the same phone name that was specified when the media engine was instantiated.

 

pNameOfEventServer

The name of the server device offering events. If event subscriptions are successful, this telephony device will send us events of the specified name/type.

 

pDestinationAddress

The address of the event server target.

 

DestinationPort

The network server port of the event server target.

 

pEventName

The name of the event the application wants to subscribe to.

 

pEventParameter

The null terminated event parameter string.

 

SubscriptionIntervalSeconds

The number of seconds the event subscription will be active. If your application is unsubscribing from events, this value will be zero.

 

SipStatus

The staus code describing the nature of this data. The value can be any of the following: SipSubscriptionTrying, SipSubscriptionMemoryError, SipSubscriptionSuccess, SipSubscriptionTimeOut, or SipSubscriptionNotAccepted.

 

SipResponseCode

The actual SIP response code returned from the destination of the subscribe operation.