1.8. GCEV_EXTENSION Events

1.8. GCEV_EXTENSION Events

There are ISDN-specific GlobalCall events, which will eventually be mapped to GCEV_EXTENSION. But to maintain backward compatibility, the GlobalCall application has the option to choose ISDN-specific events or GCEV_EXTENSION. The default is ISDN-specific events. For more information, refer to Section1.9, Run Time Configuration Management.

If the application needs to use the new generic call model or extension features, gc_Start( ) should be called as shown below:
 CCLIB_START_STRUCT cclib_struct;
GC_START_STRUCT gc_start_struct;
GC_PARM_BLK *parmblk; 
 gc_util_insert_parm_val( parmblk, GCIS_SET_GENERIC, GCIS_PARM_EXTENSIONEVENT, 
sizeof( char ), 1);
gc_util_insert_parm_val( parmblk, GCIS_SET_GENERIC, GCIS_PARM_GENERICCALLMODEL, 
sizeof( char ), 1);
 gc_start_struct.numcclibs = 1;
gc_start_struct.cclib_list = &cclib_struct;
gc_start_struct.cclib_list.cclib_name =  "GC_ISDN_LIB";
gc_start_struct.cclib_list.cclib_data = &parmblk;
 gc_util_delete_parm_blk(parmblk);
The field extevtdatap of the METAEVENT structure points to EXTENSIONEVT_BLK.
 typedef struct {
    unsigned char    	 ext_id;
    GC_PARM_BLK      	 parmblk;
} EXTENSIONEVTBLK;
The following sections define the different possible extension IDs in the GCEV_EXTENSION event.

Table 5. GCEV_EXTENSION Events
Event Description

GCIS_EXEV_CONFDROP A DROP request has been received; the request was made by sending the SndMsg_Drop message type via the gc_Extension(GCIS_EXID_SNDMSG) function. This event has two different meanings that depend upon the type of call: Two-party call - the event is a request to disconnect the call. The application should respond by issuing a gc_DropCall( ). Conference call - the event is a request to remove the last party that was added to the conference. The application needs to respond to this request with either a SndMsg_DropAck or SndMsg_DropRej message to indicate the acceptance or rejection of the request. If the request is accepted, the party is dropped from the conference. This event only pertains to a Custom BRI 5ESS switch type.

GCIS_EXEV_CONGESTION A CONGESTION message has been received by the application, indicating that the remote end is not ready to accept incoming user information. Use the gc_GetCallInfo( ) function to retrieve additional information about the event or look into the extension event data.

GCIS_EXEV_DIVERTED NAM with divert information has been received by the application. An outgoing call has been successfully diverted to another station.

GCIS_EXEV_DROPACK The network has honored a DROP request for a conference call; the request was made by sending the SndMsg_Drop message type via the gc_Extension(GCIS_EXID_SNDMSG) function. The event is sent on the corresponding line device. This event pertains only to a Custom BRI 5ESS switch type.

GCIS_EXEV_DROPREJ The network has not honored a DROP request for a conference call. The event is sent on the corresponding line device.This event pertains only to a Custom BRI 5ESS switch type.

GCIS_EXEV_FACILITY A FACILITY REQUEST message has been received by the application.

GCIS_EXEV_FACILITY_ACK A FACILITY_ACKNOWLEDGEMENT message has been received by the application.

GCIS_EXEV_FACILITY_REJ A FACILITY_REJECT message has been received by the application.

GCIS_EXEV_FACILITYGLOBAL An ISDN_FACILITY message containing a Global CRN value was received. This event is sent on the board level device, as the event is associated with all calls on the device. Upon receipt of this event, the application may issue a gc_Extension(GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.

GCIS_EXEV_FACILITYNULL An ISDN_FACILITY message was received containing a Dummy (NULL) CRN. Upon receipt of this event, the application may issue a gc_Extension(GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.

GCIS_EXEV_INFOGLOBAL An ISDN_INFORMATION message containing a Global CRN value was received. This event is sent on the board level device, as the event is associated with all calls on the device. Upon receipt of this event, the application may issue a gc_Extension(GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.

GCIS_EXEV_INFONULL An ISDN_INFORMATION message was received containing a NULL CRN. Upon receipt of this event, the application may issue a gc_Extension (GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.

GCIS_EXEV_L2BFFRFULL Reserved for future use.

GCIS_EXEV_L2FRAME A data link layer frame has been received by the application. The application should use the gc_Extension (GCIS_EXID_GETFRAME) function to retrieve the received frame. It is the application's responsibility to analyze the contents of the frame or look into the extension event data.

GCIS_EXEV_L2NOBFFR There are no buffers available to save the incoming frame.

GCIS_EXEV_NOFACILITYBUF Facility buffer is not ready

GCIS_EXEV_NOTIFY A NOTIFY message has been received by the application. Use the gc_GetCallInfo( ) function to retrieve additional information about the event or look into the extension event data.

GCIS_EXEV_NOTIFYGLOBAL An ISDN_NOTIFY message containing a Global CRN value was received. This event is sent on the board level device, as the event is associated with all calls on the device. Upon receipt of this event, the application may issue a gc_Extension (GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.

GCIS_EXEV_NOTIFYNULL An ISDN_NOTIFY message was received containing a Dummy (NULL) CRN. Upon receipt of this event, the application may issue a gc_Extension (GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.

GCIS_EXEV_NOUSRINFOBUF User IE buffer is not ready

GCIS_EXEV_NSI A Network Specific Indication (NSI) message was received from the network. The application should use gc_GetCallInfo( ) to retrieve the NSI string(s) or look into the extension event data.

GCIS_EXEV_PLAYTONE User-defined tone successfully played.

GCIS_EXEV_PLAYTONEFAIL Request to play user-defined tone failed.

GCIS_EXEV_PROGRESSING A PROGRESS message has been received by the application. By default, the firmware will send this event to the application. The application may block this event by clearing the CCMSK_PROGRESS bit. Use the gc_GetCallInfo( ) function to retrieve additional information about the event or look into the extension event data.

GCIS_EXEV_STATUS A STATUS message has been received from the network.

GCIS_EXEV_STATUS_ENQUIRY A STATUS_ENQ message has been received from the network.

GCIS_EXEV_STOPTONE The tone operation was terminated.

GCIS_EXEV_STOPTONEFAIL The request to terminate the playing of a tone failed.

GCIS_EXEV_TIMER An unsolicited event indicating that a timer has expired.

GCIS_EXEV_TONEREDEFINE The tone(s) in the firmware tone template table were successfully redefined.

GCIS_EXEV_TONEREDEFINEFAIL The request to redefine tone(s) in the firmware tone template table failed.

GCIS_EXEV_TRANSFERACK A TRANSFER ACKNOWLEDGE message was received from the network. The indicated network has accepted a request to transfer a call.

GCIS_EXEV_TRANSFERREJ A TRANSFER REJECT message was received from the network. The indicated network has rejected a request to transfer a call.

GCIS_EXEV_TRANSIT After a transfer is established, transit messages are used for relating messages between the originating end and the terminating end.

GCIS_EXEV_USRINFO A USER INFORMATION message has been received by the application, indicating that a user-to-user information (UUI) event is coming. For example, this event is received in response to a gc_Extension(GCIS_EXID_SNDMSG) function call, from the far end, in which the msg_type is SndMsg_UsrInformation. Use the gc_GetCallInfo( ) function to retrieve the UUI or look into the extension event data. Field parmblk of EXTENSIONEVTBLK will hold following parameters: GCIS_SET_IE, GCIS_PARM_UIEDATA (char array, maximum length can go to MAXLEN_IEDATA): Unprocessed IEs in CCITT format. The IEs are returned as raw data and must be parsed and interpreted by the application.

**Table 5. GCEV_EXTENSION Events**
Event	Description
GCIS_EXEV_CONFDROP	A DROP request has been received; the request was made by sending the SndMsg_Drop message type via the gc_Extension(GCIS_EXID_SNDMSG) function. This event has two different meanings that depend upon the type of call: Two-party call - the event is a request to disconnect the call. The application should respond by issuing a gc_DropCall( ). Conference call - the event is a request to remove the last party that was added to the conference. The application needs to respond to this request with either a SndMsg_DropAck or SndMsg_DropRej message to indicate the acceptance or rejection of the request. If the request is accepted, the party is dropped from the conference. This event only pertains to a Custom BRI 5ESS switch type.
GCIS_EXEV_CONGESTION	A CONGESTION message has been received by the application, indicating that the remote end is not ready to accept incoming user information. Use the gc_GetCallInfo( ) function to retrieve additional information about the event or look into the extension event data.
GCIS_EXEV_DIVERTED	NAM with divert information has been received by the application. An outgoing call has been successfully diverted to another station.
GCIS_EXEV_DROPACK	The network has honored a DROP request for a conference call; the request was made by sending the SndMsg_Drop message type via the gc_Extension(GCIS_EXID_SNDMSG) function. The event is sent on the corresponding line device. This event pertains only to a Custom BRI 5ESS switch type.
GCIS_EXEV_DROPREJ	The network has not honored a DROP request for a conference call. The event is sent on the corresponding line device.This event pertains only to a Custom BRI 5ESS switch type.
GCIS_EXEV_FACILITY	A FACILITY REQUEST message has been received by the application.
GCIS_EXEV_FACILITY_ACK	A FACILITY_ACKNOWLEDGEMENT message has been received by the application.
GCIS_EXEV_FACILITY_REJ	A FACILITY_REJECT message has been received by the application.
GCIS_EXEV_FACILITYGLOBAL	An ISDN_FACILITY message containing a Global CRN value was received. This event is sent on the board level device, as the event is associated with all calls on the device. Upon receipt of this event, the application may issue a gc_Extension(GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.
GCIS_EXEV_FACILITYNULL	An ISDN_FACILITY message was received containing a Dummy (NULL) CRN. Upon receipt of this event, the application may issue a gc_Extension(GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.
GCIS_EXEV_INFOGLOBAL	An ISDN_INFORMATION message containing a Global CRN value was received. This event is sent on the board level device, as the event is associated with all calls on the device. Upon receipt of this event, the application may issue a gc_Extension(GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.
GCIS_EXEV_INFONULL	An ISDN_INFORMATION message was received containing a NULL CRN. Upon receipt of this event, the application may issue a gc_Extension (GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.
GCIS_EXEV_L2BFFRFULL	Reserved for future use.
GCIS_EXEV_L2FRAME	A data link layer frame has been received by the application. The application should use the gc_Extension (GCIS_EXID_GETFRAME) function to retrieve the received frame. It is the application's responsibility to analyze the contents of the frame or look into the extension event data.
GCIS_EXEV_L2NOBFFR	There are no buffers available to save the incoming frame.
GCIS_EXEV_NOFACILITYBUF	Facility buffer is not ready
GCIS_EXEV_NOTIFY	A NOTIFY message has been received by the application. Use the gc_GetCallInfo( ) function to retrieve additional information about the event or look into the extension event data.
GCIS_EXEV_NOTIFYGLOBAL	An ISDN_NOTIFY message containing a Global CRN value was received. This event is sent on the board level device, as the event is associated with all calls on the device. Upon receipt of this event, the application may issue a gc_Extension (GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.
GCIS_EXEV_NOTIFYNULL	An ISDN_NOTIFY message was received containing a Dummy (NULL) CRN. Upon receipt of this event, the application may issue a gc_Extension (GCIS_EXID_GETNONCALLMSG) function to retrieve the data into its local structure or look into the extension event data.
GCIS_EXEV_NOUSRINFOBUF	User IE buffer is not ready
GCIS_EXEV_NSI	A Network Specific Indication (NSI) message was received from the network. The application should use gc_GetCallInfo( ) to retrieve the NSI string(s) or look into the extension event data.
GCIS_EXEV_PLAYTONE	User-defined tone successfully played.
GCIS_EXEV_PLAYTONEFAIL	Request to play user-defined tone failed.
GCIS_EXEV_PROGRESSING	A PROGRESS message has been received by the application. By default, the firmware will send this event to the application. The application may block this event by clearing the CCMSK_PROGRESS bit. Use the gc_GetCallInfo( ) function to retrieve additional information about the event or look into the extension event data.
GCIS_EXEV_STATUS	A STATUS message has been received from the network.
GCIS_EXEV_STATUS_ENQUIRY	A STATUS_ENQ message has been received from the network.
GCIS_EXEV_STOPTONE	The tone operation was terminated.
GCIS_EXEV_STOPTONEFAIL	The request to terminate the playing of a tone failed.
GCIS_EXEV_TIMER	An unsolicited event indicating that a timer has expired.
GCIS_EXEV_TONEREDEFINE	The tone(s) in the firmware tone template table were successfully redefined.
GCIS_EXEV_TONEREDEFINEFAIL	The request to redefine tone(s) in the firmware tone template table failed.
GCIS_EXEV_TRANSFERACK	A TRANSFER ACKNOWLEDGE message was received from the network. The indicated network has accepted a request to transfer a call.
GCIS_EXEV_TRANSFERREJ	A TRANSFER REJECT message was received from the network. The indicated network has rejected a request to transfer a call.
GCIS_EXEV_TRANSIT	After a transfer is established, transit messages are used for relating messages between the originating end and the terminating end.
GCIS_EXEV_USRINFO	A USER INFORMATION message has been received by the application, indicating that a user-to-user information (UUI) event is coming. For example, this event is received in response to a gc_Extension(GCIS_EXID_SNDMSG) function call, from the far end, in which the msg_type is SndMsg_UsrInformation. Use the gc_GetCallInfo( ) function to retrieve the UUI or look into the extension event data. Field parmblk of EXTENSIONEVTBLK will hold following parameters: GCIS_SET_IE, GCIS_PARM_UIEDATA (char array, maximum length can go to MAXLEN_IEDATA): Unprocessed IEs in CCITT format. The IEs are returned as raw data and must be parsed and interpreted by the application.

Click here to contact Dialogic Customer Engineering