3. Events

This chapter describes the events that are returned by the IP Media software functions. The function descriptions in Chapter 2, "Function Information" lists the function's termination events for asynchronous operations.

There are three types of events returned by the IP Media software functions:

• events returned after the termination of a function call, called termination events
• unsolicited events triggered by external events
• notification events requested (solicited) by the application

Applications can enable or disable certain notification events for Quality of Service (QoS) information. The notification events supported by the IP Media library are enabled and disabled via the function calls ipm_EnableEvents( ) and ipm_DisableEvents( ), respectively.

The following events, listed in alphabetical order, may be returned by the IP Media software. Use sr_waitevt( ), sr_enbhdlr( ) or other SRL functions to collect an event code, depending on the programming model in use. For more information, see the Standard Runtime Library API Library Reference.

IPMEV_DIGITS_RECEIVED

Unsolicited event for ipm_ReceiveDigits( ) in either synchronous or asynchronous mode. IPM_DIGIT_INFO contains data. One event is returned for each digit that is received.

IPMEV_ERROR

Termination event. No data is returned. Event generated on any handle when there is an error.

IPMEV_EVENT_DISABLED

Termination event for ipm_DisableEvents( ). No data is returned. Indicates specified IP notification events have been disabled.

IPMEV_EVENT_ENABLED

Termination event for ipm_EnableEvents( ). No data is returned. Indicates specified IP notification events have been enabled.

IPMEV_FAXTONE

Unsolicited event for ipm_EnableEvents( ). IPM_FAX_SIGNAL contains data. Event is returned when fax tone is detected on TDM.

IPMEV_GET_LOCAL_MEDIA_INFO

Termination event for ipm_GetLocalMediaInfo( ). IPM_MEDIA_INFO contains data. Indicates local media information has been returned.

IPMEV_GET_PARM

Termination event for ipm_GetParm( ). IPM_PARM_INFO contains data. Indicates IP channel parameters have been returned.

IPMEV_GET_QOS_ALARM_STATUS

Termination event for ipm_GetQoSAlarmStatus( ). IPM_QOS_ALARM_STATUS contains data. Indicates alarm status information was filled in.

IPMEV_GET_QOS_THRESHOLD_INFO

Termination event for ipm_GetQoSThreshold( ). IPM_QOS_THRESHOLD_INFO contains data. Indicates alarm threshold settings have been returned.

IPMEV_GET_SESSION_INFO

Termination event for ipm_GetSessionInfo( ). IPM_SESSION_INFO contains data. Indicates statistics for previous session have been returned.

IPMEV_GET_XMITTS_INFO

Termination event for ipm_GetXmitSlot( ). SC_TSINFO contains data. Indicates TDM time slot information has been returned.

IPMEV_LISTEN

Termination event for ipm_Listen( ). No data is returned. Indicates time slot routing was successfully completed.

IPMEV_OPEN

Termination event for ipm_Open( ). No data is returned. Indicates IP channel was successfully opened and device handle is valid.

IPMEV_PING

Termination event for ipm_Ping( ). IPM_PING_INFO contains data. Indicates ping response has been returned.

IPMEV_QOS_ALARM

Unsolicited event for ipm_EnableEvents( ). No data is returned. Event is returned when desired QoS alarm triggers.

IPMEV_RECEIVE_DIGITS

Termination event for ipm_ReceiveDigits( ). No data is returned. Indicates channel has been enabled to receive digits.

Note: IPMEV_DIGITS_RECEIVED indicates digit transfer has occurred.

IPMEV_RESET_QOS_ALARM_STATUS

Termination event for ipm_ResetQoSAlarmStatus( ). No data is returned. Indicates specified QoS alarms have been reset to OFF state.

IPMEV_RFC2833SIGNALRECEIVED

Unsolicited event for ipm_EnableEvents( ). IPM_RFC2833_SIGNALID_INFO contains data. Event is returned when RFC 2833 signal is detected on IP.

IPMEV_SEND_DIGITS

Termination event for ipm_SendDigits( ). No data is returned. Indicates supplied digits were sent successfully.

IPMEV_SEND_SIGNAL_TO_IP

Termination event for ipm_SendRFC2833SignalIDToIP( ). No data is returned. Indicates RFC2833 message has been sent to IP.

IPMEV_SET_PARM

Termination event for ipm_SetParm( ). No data is returned. Indicates IP channel parameters have been modified.

IPMEV_SET_QOS_THRESHOLD_INFO

Termination event for ipm_SetQoSThreshold( ). IPM_QOS_THRESHOLD_INFO contains data. Indicates modified QoS alarm threshold levels have been returned.

IPMEV_SET_REMOTE_MEDIA_INFO

Termination event for ipm_SetRemoteMediaInfo( ). IPM_MEDIA_INFO contains data. Indicates media channel information has been set and session has been started.

IPMEV_STARTMEDIA

Termination event for ipm_StartMedia( ). No data is returned. Indicates media channel information has been set and session has been started.

IPMEV_STOPPED

Termination event for ipm_Stop( ). No data is returned. Indicates all on-going activity on the IP channel has terminated.

IPMEV_T38CALLSTATE

Unsolicited event for ipm_EnableEvents( ). eIPM_T38CALLSTATE contains data. Event is returned when T.38 call state changes.

IPMEV_UNLISTEN

Termination event for ipm_UnListen( ). No data is returned. Indicates IP channel was disconnected from TDM time slot.

Click here to contact Telecom Support Resources