Home

Intel 05-2409-003 Digital Camera User Manual

1. GCST_CONNECTED or GCST_HELD GCEV_ACCEPT_XFER_FAIL GCEV_REQ_XFER GCEV_REJ_XFER GCEV_REJ_XFER_FAIL GCEV_XFER_FAIL GCST_REQ_XFER GCEV_ACCEPT_XFER _ _ _ _ _ gc_MakeCall C3 l GCST_DIALING MS os GCEV_XFER_CMPLT GCEV_PROCEEDING a ee GCST_ACCEPT_XFER GCST_XFER_CMPLT GCST_PROCEEDING 3 N GCEV_DISCONNECTED GCEV_ALERTING Po ee A GCST_DISCONNECTED GCST_ALERTING N ra GCEV_DROPCALL GCEV_CONNECTED GCST_IDLE GCST_CONNECTED GCEV_RELEASE GCST_NULL Global Call API for HMP on Windows Programming Guide August 2006 137 E Using Global Call to Implement Call Transfer n Figure 40 Call State Model for Supervised Transfer at Party C Transferred To Party Party C Call 2 Call 3 GCST_IDLE GCEV_DETECTED poe GCST_DETECTED GCST_CONNECTED or GCST_HELD GCEV_ACCEPT_INIT_XFER or GCEV_REJ_INIT_XFER or GCEV_REJ_INIT_XFER_FAIL or GCEV_ACCEPT_INIT_XFER_FAIL 3CEV_REQ_INIT_XFER d a GCST_REQ_INIT_XFER GCEV_DISCONNECTED XFER CMPLT GCEV_OFFERED GCST_OFFERED GCEV_ANSWERED GCST_CONNECTED GCEV_DISCONNECTED GCST_DISCONNECTED GCST_DISCONNECTED GCEV_DROPCALL GCST_IDLE GCEV_RELEASE GCST_NULL 138 Global Call API for HMP on Windows Programming Guide August 2006 intel Building Applications 12 This chapter provides general information for build applicat
2. Note The state diagrams in Figure 36 and Figure 37 apply to the case where party B initiates the transferred call to party C see Figure 34 and not to the case where Party A places the primary call with party B on hold and then calls party C Global Call API for HMP on Windows Programming Guide August 2006 133 Using Global Call to Implement Call Transfer n Figure 36 Call State Model for Blind Call Transfer at Party A Transferring Party Party A GCEV_INVOKE_XFER_REJ GCEV_INVOKE_XFER_FAIL GCST_CONNECTED or GCST_HOLD GCEV_INVOKE__ XFER FAIL ep eee v___ GCST_INVOKE_ XFER_ACCEPTED Nee aaa GCEV_INVOKE_XFER Pa GCEV_INVOKE_XFER GCST_INVOKE_XFER GCEV_DISCONNECTED XFER CMPLT GCST_DISCONNECTED GCEV_DROPCALL GCST_IDLE GCEV_RELEASECALL GCST_NULL 134 Global Call API for HMP on Windows Programming Guide August 2006 n Using Global Call to Implement Call Transfer Figure 37 Call State Model for Blind Transfer at Party B Transferred Party Party B GCST_CONNECTED or GCST_HELD GCEV_REJ_XFER GCEV_REQ_XFER GCEV_ACCEPT_XFER_FAIL GCEV_REJ_XFER_FAIL GCEV_XFER_FAIL GCST_REQ_XFER GCEV_ACCEPT_XFER gc_MakeCall CRN2 GCST_ACCEPT_XFER ee ee ee GCEV_XFER_CMPLT GCST_DIALING GCST_XFER_CMPLT GCEV_PROCEEDING a ee ee GCEV_DISCONNECTED GCST_PROCEEDING XFER CMPLT Ne ZA GCST_DISCONNECTED eer SSS SS EN GCEV_DROP
3. General Programming Tips on page 77 for details Of the asynchronous models the asynchronous with SRL callback model and the asynchronous with Windows callback model provide the tightest integration with the Windows message event mechanism Asynchronous model applications are typically more complex than corresponding synchronous model applications due to a higher level of resource management that is the number of channels managed by a thread and the tracking of completion events and the development of a state machine After the application issues an asynchronous function the application uses the sr_waitevt function to wait for events on Intel Dialogic devices All event coding can be accomplished using switch statements in the main thread When an event is available event information may be retrieved using the gc_GetMetaEvent function Retrieved event information is valid until the sr_waitevt function is called again The asynchronous model does not use event handlers to process events In this model the SRL handler thread must be initiated by the application by setting the SR_MODELTYPE value to SR_STASYNC Asynchronous Model with Event Handlers The asynchronous with event handlers model uses the sr_enbhdlr function to automatically create the SRL handler thread The application does not need to call the sr_waitevt function since the thread created by the sr_enbhdlr already calls the sr_waitevt function to get event
4. Task Failure If the ge_ MakeCall cannot be completed successfully a GCEV_TASKFAIL event or a GCEV_DISCONNECTED event is sent to the application The result value associated with the event indicates the reason for the event If the GCEV_TASKFAIL event is sent then a problem occurred when placing the call from the local end Global Call API for HMP on Windows Programming Guide August 2006 57 Call State Models 3 4 2 9 Outbound Call Scenarios in Asynchronous Mode In tel This section shows various asynchronous outbound call scenarios For call scenarios used for a specific signaling protocol check the Global Call Technology Guide for that technology Figure 12 shows a basic asynchronous call scenario for outgoing calls Figure 12 Asynchronous Outbound Call Scenario 58 GlobalCall Library Technology Application l gc_MakeCall Outbound Call GCEV_DIALING Alerting GCEV_ALERTING Call Answered GCEV_CONNECTED Network Global Call API for HMP on Windows Programming Guide August 2006 ntel Call State Models Figure 13 shows an asynchronous call scenario for outgoing calls with call acknowledgement Figure 13 Asynchronous Outbound Call Scenario With Call Acknowledgement gc_MakeCall GlobalCall Library Technology Outbound Call GCEV_DIALING Call Proceeding GCEV_PROCEEDING Alerting GCEV_ALERTING Call Answered GCEV_CONNECTED
5. The gc_ResetLineDev function is used to speed the update of the parameters that are waiting for the arrival of the Null state For example the customer application can call the gc_SetConfigData function multiple times to request the parameters to be updated at the Null state Instead of waiting for the Null state the customer application can call the gc_ResetLineDev function to reset the channel to the Null state and update all the parameters Handling RTCM Errors Configuration data for multiple parameters of a target object can be updated in a single function call The function will abort on any single parameter retrieval failure If the function returns a Global Call error the application calls the ge_ErrorInfo function immediately to obtain the last error code error message and additional message An additional message identifies which parameter has an error In the asynchronous mode the application calls the gc_ResultInfo function immediately to obtain the result value error message and additional message See the Global Call API Library Reference for Global Call RTCM error values and messages Configuration Procedure The basic steps for using the Global Call RTCM feature are 1 Ensure that the target object has been opened or loaded and find the target object ID 2 Find the parameter information set ID parm ID and data type related to the target object 3 Find the parameter update condition or requirement U
6. Connected Call 1 gc_DropCall Call 2 Idle Call 2 GCEV_DROPCALL Call 2 GCEV_CONNECTED Call 1 Note This can be Call 1 or Call 2 gc_ReleaseCallEx Call 2 depending on which call is currenly active that is not in an OnHoldPendingTransfer state Connected Call 1 Null Call 2 Note In Figure 20 when ge_DropCall is issued an unsolicited GCEV_CONNECTED event is received for call 1 transitioning it back to the Connected state 3 5 4 3 Unsupervised Transfers In an unsupervised transfer a successful call to the ge_BlindTransfer function transfers the call in a single step without any consultation or announcement by the person transferring the call Internally the currently connected call is placed on hold the new party is dialed and finally the connection to both parties is relinquished When the application receives the GCEV_BLINDTRANSFER event the original call enters the GCST_IDLE state At this point the application must call ge_ReleaseCallEx for the call to release the allocated resources Once the new party is dialed the control and responsibility for the results of the transfer whether successfully connected or not lie totally with the remote party once the transfer is relinquished Only one call is controlled by the application as the transfer is initiated internally via the protocol Unsupervised transfers do not provide call progress results for the transfer nor do they support terminating the tra
7. Global Call API for Host Media Processing on Windows Programming Guide August 2006 05 2409 003 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS NO LICENSE EXPRESS OR IMPLIED BY ESTOPPEL OR OTHERWISE TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT EXCEPT AS PROVIDED IN INTEL S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS INTEL ASSUMES NO LIABILITY WHATSOEVER AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY RELATING TO SALE AND OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE MERCHANTABILITY OR INFRINGEMENT OF ANY PATENT COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT Intel products are not intended for use in medical life saving life sustaining critical control or safety systems or nuclear facility applications Intel may make changes to specifications and product descriptions at any time without notice This Global Call API for Host Media Processing on Windows Programming Guide as well as the software described in it is furnished under license and may only be used or copied in accordance with the terms of the license The information in this manual is furnished for informational use only is subject to change without notice and should not be construed as a commitment by Intel Corporation Intel Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear in this document or any software
8. Global Call API for HMP on Windows Programming Guide August 2006 149 a intel condition The application receives a GCEV_UNBLOCKED event to indicate that the line device has moved to an unblocked condition from a previously blocked condition See also blocked unsupervised transfer A transfer in which the call is transferred without any consultation or announcement by the person transferring the call UUI User to User Information Proprietary messages sent to remote system during call establishment Vari A Bill Service bureaus can vary the billing rate of a 900 call at any time during the call Callers select services from a voice automated menu and each service can be individually priced voice channel Designates a bi directional transfer of data for a single call between a voice device processing that call and the SCbus Digitized voice from the T1 E1 interface device is transmitted over the SCbus to the voice receive listen channel for processing by the voice device The voice device sends the response to the call over the voice transmit channel to an SCbus time slot that transmits this response to the T1 E1 interface device voice handle SRL device handle associated with a voice channel equivalent to the device handle returned from the voice library s dx_open function voice resource See voice channel 150 Global Call API for HMP on Windows Programming Guide August 2006 intel Index A abandoned calls 47
9. Global Call API for HMP on Windows Programming Guide August 2006 59 Call State Models i ntel Figure 14 shows an asynchronous call scenario for outgoing calls with overlap sending Note This scenario applies to E1 T1 and ISDN technologies only Figure 14 Asynchronous Outbound Call Scenario With Overlap Sending GlobalCall Application Library Network Technology gc_MakeCall Outbound Call GCEV_DIALING Request More Address Information GCEV_REQMOREINFO gc_SendMorelnfo DESTINATION_ADDRESS More Address Information GCEV_SENDMOREINFO Call Proceeding GCEV_PROCEEDING Alerting GCEV_ALERTING Call Answered 3 4 3 Call Termination in Asynchronous Mode GCEV_CONNECTED This section describes how calls are terminated and shows call scenarios for asynchronous call termination The following topics describe call termination in asynchronous mode e Call Termination in Asynchronous Mode Overview e User Initiated Termination Network Initiated Termination Call Release Call Termination Call Control Scenarios in Asynchronous Mode 60 Global Call API for HMP on Windows Programming Guide August 2006 intel 3 4 3 1 Call State Models Call Termination in Asynchronous Mode Overview Figure 15 illustrates the call states associated with call termination or call teardown in the asynchronous mode initiated by either a call disconnection or failure See Table 8 for a summary of the call
10. Global Call application Failed A library that has failed to start is considered to be unavailable for use by a Global Call application Each configured call control library is assigned an ID number by Global Call Each library also has aname in an ASCII string format Library functions perform tasks such as converting a call control library ID to an ASCII name and vice versa determining the configured libraries determining the available libraries determining the libraries started and the libraries that failed to start and other library functions The following functions are the call control library information functions All the library functions are synchronous thus they return without a termination event e gc CCLibIDToName e gc CCLibNameToID e gc _CCLibStatusEx e gc GetVer See the Global Call API Library Reference for detailed information about these functions Global Call Object Identifiers The Global Call API is call oriented that is each call initiated by the application or network is assigned a Call Reference Number CRN for call control and tracking purposes Call handling is independent of the line device over which the call is routed Each line device or device group is assigned a Line Device Identifier LDID that enables the application to address any resource or Global Call API for HMP on Windows Programming Guide August 2006 23 E Product Description ntel A 1 5 1 1 5 2 24 gr
11. The LDID associated with an event is available from the linedev field of the METAEVENT If the event is related to a CRN that CRN is available from the crn field of the METAEVENT if the crn field of the METAEVENT is 0 then the event is not a call related event The METAEVENT structure also includes an extevtdatap field which contains a pointer to more information about the event The memory pointed to by the extevtdatap field should be treated as read only and should not be altered and or freed The application should issue a ge_DropCall function before issuing the gc_ReleaseCallEx function Failure to issue this function could result in one or more of the following problems e memory problems due to memory being allocated and not being released e a blocking condition e events sent to the previous user of a CRN that could be processed by a later user of the CRN with unexpected results The reason for an event can be retrieved using the gc_ResultInfo function The information returned uniquely identifies the cause of the event Global Call API for HMP on Windows Programming Guide August 2006 73 Event Handling i ntel 4 5 4 6 4 7 74 Events Indicating Errors Events that explicitly provide error indications are as follows GCEV_TASKFAIL Received when an API function call fails When this events is received the application should call gc_ResultInfo immediately after the event arrives to determine the reas
12. alarm flow 102 alarm handling 97 alarm source objects 97 ALARM_SOURCE_ID_NETWORK_ID usage 101 alarms 97 blocking 99 GCEV_UNBLOCKED event 99 non blocking 99 recovery 99 application handler thread Windows 75 ASO 97 asynchronous mode Windows 29 asynchronous models Windows 30 asynchronous programming model Windows 30 asynchronous with SRL callback 74 75 asynchronous with SRL callback model Windows 30 asynchronous with Win32 synchronization Windows 30 asynchronous with Win32 synchronization model 31 asynchronous with Windows callback Windows 30 asynchronous with Windows callback model Windows 31 blind call transfer 69 blocking alarms 99 time slot level 100 trunk level 100 blocking condition 73 C call reference number multiple 83 call state transitions summary 53 call states asynchronous termination summary 61 call teardown 61 call termination 61 asynchronous 61 call transfer supervised 67 unsupervised 69 CRN Call Reference Number 24 lifespan 25 D data structures GC_RTCM_EVTDATA 116 METAEVENT 73 device handles extracting 93 Disconnected state transition 61 transition when alarm occurs 99 drop and insert applications programming tips 78 E error events GCEV_TASKFAIL 85 error handling 85 event data in metaevent 73 event handlers 74 event handler thread 74 SRL event handler thread 31 Windows 30 event mask 64 event notification asynchronous mode programming 29 event
13. line device To retrieve the status of the alarm configuration parameters use the gc_GetAlarmConfiguration function Alternatively the ge _SetAlarmNotifyAll function can be used as a shortcut when the application wants to change the notification status that is when the application wants to change from notify to no notify for all line devices that have the specified alarm source object Configuring Alarm Flow The ge_SetAlarmFlow function is used to further refine which of the alarms are sent that is allowed to flow to the application Alarm flow configuration is controlled on a line device basis The alarm flow can be configured in any of the following ways e All alarms are sent to the application e All and only blocking alarms are sent to the application e Only the first alarm on and the last alarm off are sent to the application e Only the first blocking alarm on and the last blocking alarm off are sent to the application To configure the alarm flow so that no alarms are sent to the application use the gc_SetAlarmConfiguration function and set the notify attribute of all alarms to no To determine the current alarm flow options use the ge_GetAlarmFlow function Configuring Blocking and Non Blocking Alarm Classification For any given alarm source object the gc_SetAlarmConfiguration function can be used to set and change which alarms are blocking or non blocking This information is sto
14. pending 100 GCEV_UNBLOCKED event for alarm recovery 99 Global Call API overview 21 architecture 19 call control library overview 22 major components 17 product overview 17 ID number library 23 identifying a call using CRN 24 Idle state transition to 61 information retrieval via metaevents 73 internal SRL event handler thread 74 L LDID Line Device Identifier 24 in METAEVENT structure 73 libraries ASCII name string 23 ID numbers 23 Line Device Identifier LDID 24 M message eventing Windows 30 METAEVENT data structure 30 32 caution re Multiple threads 32 retrieval of LDID 24 metaevents 73 multiple threads caution re gc_GetMetaEventEx _ 32 N network ASO ID usage 101 152 Global Call API for HMP on Windows Programming Guide August 2006 intel non blocking alarms 99 Null state call termination 62 P programming tips choosing a programming model in Windows 78 drop and insert applications 78 general 77 protocol handler 71 protocol operation errors 85 R resource sharing 25 S setting up a call 53 signal handlers 64 sr_enbhdlr _ 30 74 SR_MODELTYPE 30 31 32 75 SR_MODELTYPE value 74 sr_NotifyEvt _ 31 sr_setparm _ 74 SR_STASYNC 75 sr_waitevt _ 29 30 31 32 75 sr_waitevtEx _ 32 SRL event handler thread 31 32 SRL events 29 SRL handler thread 30 Windows 30 SRL handler thread Windows 74 state accepted 41 alerting 55 connected 41 dia
15. this field should match the ID assigned when the request was first made PARM_REQTYPE int the type of request made Refer to the appropriate Global Call Technology Guide for the actual values PARM_ACK short the acknowledgement field with the following usage e When used for a service request a value of GC_ACK indicates that a response is required and a value of GC_NACK indicates that no response is necessary e When used for a service response a value of GC_ACK indicates a confirmation and a value of GC_NACK indicates a rejection Depending on the call control library used additional parameters may also be used Refer to the Global Call API Library Reference for more information about the GC_PARM_BLK data structure Before the Service Request feature can be used a GC_PARM_BLK data structure must be set up to handle the data associated with the service request Each request or response is assigned a Service ID by the call control library and should be used by the application when generating responses as well as to distinguish among different request and responses See the GC_PARM_BLK data structure and utility functions gc_util_xxx in the Global Call API Library Reference for more information on setting up the data structure for the Service Request feature Notes 1 When using the gc_ReqService function PARM_REQTYPE and PARM_ACK are mandatory parameters of the GC_PARM_BLK pointed to by the reqdatap function parameter 2 W
16. 114 Getting and Setting Parameter Information The Global Call RTCM feature supports the retrieval E1 T1 and ISDN technologies only or updating all technologies of multiple parameters of the same target object in a single Global Call API function call The functions used to get and set configuration data are as follows gc_GetConfigData E1 T1 and ISDN technologies only retrieves the configuration data from a given target object gc_SetConfigData all technologies updates the configuration data of a given target object The function call must include a valid target object that is consistent with the target ID In addition the following conditions must exist e Valid parameters set ID and parm ID supported by this target object e Correct parameter data type and data value e Appropriate control parameters programming mode timeout update condition have been set The set ID and parm ID as well as the data type and data value are specified in the function call using the GC_PARM_BLK data structure GC_PARM_BLK Data Structure As an argument of the ge _SetConfigData function all technologies and the gc_GetConfigData function E1 T1 and ISDN technologies only the configuration data is required to be a generic GC_PARM_BLK data structure The Global Call application must input parameter information such as the set ID parm ID and value strictly following entry specifications In addition to inputting a valid set
17. 131 11 1 2 Supervised Call Transfer 00 ccc eee 132 11 2 Call Transfer State Machine 000 ccc eee 132 Building Applications 0 0 0 ce teens 139 12 1 Compiling and Linking s s esasa 0 0 tees 139 T2431 Include Files 344d eed Ss Se a eee Re ee Be AES os 139 12 1 2 Required Libraries 0 0 0c es 139 12 1 3 Variables for Compiling and Linking Commands 0 000000 140 12 1 4 Dynamically Loaded Libraries naana 140 De DUQGING ea aed oat Bee hal ws anthem baleen Ridden ei ae Get are ale a 141 Global Call API for HMP on Windows Programming Guide August 2006 5 Contents i ntel 6 Global Call API for HMP on Windows Programming Guide August 2006 ntel M Contents Figures OANOOAARWDND 11 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 Global Call Architecture for IP Technology 00 cece eee 20 Global Call Architecture for E1 T1 and ISDN Technologies 00000 eens 21 Call Control Library States 0 0 0 0 eens 23 Basic Asynchronous Inbound Call State Diagram 00 0 eee 40 Basic Asynchronous Inbound Call Scenario 0 6 aeaaaee 47 Incoming Call Scenario with Call Proceeding 0 0 0c cece eae 48 Call Acknowledgement and Call Proceeding Done at the Application Layer 49 Call Proceeding Done by the Application Layer with Minimum I
18. 3 5 Call Termination Call Control Scenarios in Asynchronous Mode This section shows various asynchronous call termination call scenarios For call scenarios used for a specific signaling protocol check the Global Call Technology Guide for that technology Figure 16 shows an asynchronous user initiated call termination scenario Figure 16 User Initiated Asynchronous Call Termination Scenario Application gc_DropCall GCEV_DROPCALL gc_ReleaseCallEx GlobalCall Library Technology Disconnect Call Disconnected GCEV_RELEASECALL Figure 17 shows an asynchronous network initiated call termination scenario 62 Global Call API for HMP on Windows Programming Guide August 2006 ntel Call State Models Figure 17 Network Initiated Asynchronous Call Termination Scenario GlobalCall Application Library Network Technology Disconnected GCEV_DISCONNECTED gc_DropCall GCEV_DROPCALL gc_ReleaseCallEx Call Disconnected GCEV_RELEASECALL Global Call API for HMP on Windows Programming Guide August 2006 63 Call State Models i ntel 3 4 4 Handling Unsolicited Events The application must handle unsolicited events in the synchronous mode unless these events are masked or disabled The ge_SetConfigData function specifies the events that are enabled or disabled for a specified line device This function sets the event mask associated with the specified line devi
19. A consultation CRN is allocated with the initial state of GCST_DIALTONE and is returned by the gc_SetupTransfer function 3 The gc_MakeCall function is called to establish a connection on the consultation call The CRN returned by ge_MakeCall is the same CRN as was returned by gc_SetupTransfer 4 The consultation call proceeds similarly to a singular outbound call proceeding through the GCST_DIALING and GCST_ALERTING if enabled call states See Section 3 4 Basic Call Control in Asynchronous Mode for more information 5 If the consultation call is successfully established the state of the consultation call changes to the GCST_CONNECTED state and the state of the original call remains unchanged 6 While the consultation call is in the GCST_CONNECTED state the ge_SwapHold function may be used to switch between the call pending transfer and the consultation call 7 A call to the ge_CompleteTransfer function transfers the original call to the consultation call and internally drops both channels 8 The states of the original and the consultation call both change to the GCST_IDLE state upon receipt of the GCEV_COMPLETETRANSFER event 9 The application must call ge_ReleaseCallEx for both of the calls to release the resources allocated for both channels The consultation call may be terminated at any point in the process by the application or by the detection of a call disconnect from the network The call sta
20. DESTINATION_ADDRESS More Information gc_GetCalllnfo ORIGINATION_ADDRESS New Information gc_CallAck CACK_SERVICE_INFO Buffered GCEV_MOREINFO gc_CallAck GCACK_SERVICE_PROC GCEV_CALLPROC gc_AcceptCall Call Proceeding Alerting GCEV_ACCEPTED gc_AnswerCall Call Answered GCEV_ANSWERED Global Call API for HMP on Windows Programming Guide August 2006 ntel Call State Models Figure 9 shows an asynchronous call scenario for an incoming call with call acknowledgement and call proceeding controlled by the call control layer Figure 9 Call Acknowledgement and Call Proceeding Done at Technology Call Control Layer GlobalCall Application Library Network Technology Not Enough Incoming Call Information Acknowledgement Received and Request for More Address Information More Information All Information Received GCEV_DETECTED GCEV_OFFERED gc_GetCalllnfo DESTINATION_ADDRESS gc_GetCalllnfo ORIGINATION_ADDRESS Call Proceeding gc_AcceptCall GCEV_ACCEPTED gc_AnswerCall GCEV_ANSWERED Note In Figure 9 the Acknowledgement and Request for More Address Information applies to E1 T1 and ISDN technologies only Alerting Call Answered Global Call API for HMP on Windows Programming Guide August 2006 51 Call State Models i ntel Figure 10 shows an asynchronous call scenario for an incoming call with call acknowledgement contro
21. IDS 0 eee 26 Target Object Availability 0 0 0 0 tte ae 27 Obtaining Target IDS 1 2 eee eee 27 Asynchronous Inbound Call State Transitions 0 0 0000 cee eee 41 Asynchronous Outbound Call State Transitions asas aeaaaee 55 Asynchronous Call Termination Call State Transitions saana aaae 61 Unsolicited Events Requiring Signal Handlers 00 000 cece eee 64 Handling Glais 2220 e0s08 axaeeebeed Mean ai e DREN ia hes day eng eeeeeereen esis 83 Call Progress Analysis Settings and Possible Results 0 0000 cece ene eee 89 Comparison with Call Progress Analysis Using gc_SetParm 0 000 ee eee 92 Update Condition Flag and Global Call Process 0 00 cece 117 New Global Call Transfer Call States 0 0 0 0 0c 133 Global Call API for HMP on Windows Programming Guide August 2006 9 Contents ntel 5 10 Global Call API for HMP on Windows Programming Guide August 2006 intel Revision History This revision history summarizes the changes made in each published version of this document Document No Publication Date Description of Revisions 05 2409 003 August 2006 Call Control Libraries section Updated the library descriptions to identify the technologies protocols that each library supports Using Protocols Flexible Routing section Removed incorrect reference to using the DM3 PDK Manager Setting Call Analysis Attributes on
22. a GCEV_RESETLINE event is received If the gc_SetConfigData function is successful a GCEV_SETCONFIGDATA event is received If the GCEV_SETCONFIGDATA_FAIL event is received call the ge_ResultInfo function to find the error and correct it 9 7 5 Setting Board Device Configuration in Asynchronous Mode IP Technology The Global Call RTCM allows the customer application to change the default configuration of a board device in asynchronous mode Asynchronous mode is generally suggested to be used in either of the following cases e The request is to update parameters that are call related and the channel is not at the NULL state e The target type is GCTGT_CCLIB_NETIF Figure 31 shows the procedure for setting board device configuration in asynchronous mode for IP technology Figure 31 Setting Board Device Configuration in Asynchronous Mode IP Technology Application GlobalCall Library Received Connected or GCEV_CONNECTED or Answered Event GCEV_ANSWERED ge_util_insert_parm_ref or Create Target Data for Parameters gc_util_insert_parm_val of the Line Device Set the Parameters if this Timeslot c_SetConfigData a 9 0 Target Object in Asynchronous Mode Received SETCONFIGDATA Event GCEV_SETCONFIGDATA 124 Global Call API for HMP on Windows Programming Guide August 2006 a ntel Real Time Configuration Management The procedure for setting the configuration of a board device in asynch
23. as ISDN and SS7 do not have any messages or signals to request more information For such protocols the application never gets the unsolicited GCEV_REQMOREINFO event In this case the application may call the ge_SendMoreInfo function to send more information as it becomes available Call Failure The following are two causes of call failures Call Rejection When the remote end does not answer the call aGCEV_DISCONNECTED event is generated This event is also generated when an inbound call arrives while the application is setting up an outbound call causing a glare condition Unless the protocol specifies otherwise the incoming call takes precedence over the outbound call When an asynchronous gc_MakeCall function conflicts with the arrival of an inbound call all the resources need to be released for the outbound call Subsequently the GCEV_DISCONNECTED event is generated with a result value indicating that an inbound call took precedence The gc_DropCall function must be issued after the GCEV_DISCONNECTED event is received If a ge MakeCall function is issued while the inbound call is being set up the gc_MakeCall function fails The inbound call event is held in the driver until the CRN of the outbound call is released using the gc_ReleaseCallEx function After release of the outbound CRN the pending inbound call event is sent to the application This behavior may be modified by the individual protocol specification
24. by issuing the gc_GetCallInfo function If more information is still required the ge_ReqMoreInfo function is issued to request more information When the information is received the GCEV_MOREINFO event is generated again When all the required information is received the technology call control layer sends a call proceeding indication to the remote side The application may also attempt to send a call proceeding indication to the remote side in case the technology call control layer hasn t done so The application can then choose to accept or answer the call Call Failure The following are various causes of call failures Call Rejection From the Offered state the application or thread may reject the call by issuing the gc_DropCall function followed by a ge_ReleaseCallEx function see the Global Call API Library Reference Forced Release applies to E1 T1 and ISDN technologies only From the Accepted state not all protocols support a forced release of the line that is issuing a gc_DropCall function after a ge_AcceptCall function If a forced release is not supported and is attempted the function will fail and an error will be returned To recover the application should issue the ge_AnswerCall function followed by ge_DropCall and gc_ReleaseCallEx functions However any time a GCEV_DISCONNECTED event is received in the Accepted state the ge_DropCall function can be issued Task Failure If a call fails a
25. drop and insert application in which the calling party needs to be notified of the exact status of the called party s line the following approach may be used Upon receipt of an incoming call from a calling party issue a ge_MakeCall function on the outbound line to the called party After dialing completes on the outbound line the application should drop the dialing resource turn off call progress and connect the inbound line to the outbound line so that the calling party can hear the tones returned on the outbound line These tones provide positive feedback to the calling party as to the status of the called party s line If the status of the called party s line is such that the call cannot be completed the calling party hangs up and the application can then drop the call and release the resources used Otherwise when the call is answered aGCEV_CONNECTED event will be received When call progress is being used after dialing completes the call progress software looks for ringback or voice on the outbound line When ringback is detected a GCEV_ALERTING event is generated When voice is detected a GCEV_ANSWERED event is generated An unacceptable amount of time may lapse before either of these events is generated while the calling party is waiting for a response that indicates the status of the call Thus for drop and insert applications call progress should be disabled as soon as dialing completes and the inbound and outbound lin
26. eee 80 5 3 3 Handling Multiple Call Objects Per Channel in a Glare Condition 83 6 Error Handling s asierea e tee te Atl ike Seki ee sett A Ie E cae ats E ei deg 85 6 1 Error Handling Overview sasaaa saacana 85 7 Call Control rssi cine ana 229 Oe ew Eee ade Sea ee eee ees Jae ieee fa 87 7 1 Call Progress Analysis when Using IP Technology 000 0c eee eee eae 87 7 2 Call Progress Analysis when Using Digital Network Interface Boards 87 7 2 1 Call Progress Analysis Definition 0 00 0c eee ee 87 7 2 2 Configuring Default Call Progress Analysis Parameters 0 88 7 2 3 Configuring Call Progress Analysis on a Per Call Basis 88 7 2 4 Setting Call Analysis Attributes on a Per Call Basis 000 90 7 2 5 Configuring Call Progress Analysis on a Per Channel Basis 91 7 2 6 Setting Call Analysis Attributes on a Per Channel Basis 92 7 2 7 Customizing Call Progress Tones on a Per Board Basis 2 92 7 3 Resource Routing 0 00 c eee eee eens 93 7 4 Feature Transparency and Extension 0 000 eee eee 93 7 4 1 Feature Transparency and Extension Overview 00000 cee eaee 93 7 4 2 Technology Specific Feature Access 000 cece eee 94 7 4 3 Technology Specific User Information 000000 e eee 95 8 Alarm Handing neess oee teas ada ee CMS ee deta we U
27. ie a a Ea E a a E a RA e a 112 9 3 1 Parameter Dependencies 2 00 eee 113 9 3 2 Parameter Definitions 0 0 00 cee 113 9 4 Getting and Setting Parameter Information 0000 c cee eee 114 9 4 1 GC_PARM_BLK Data Structure 0 0 00 eee 114 9 4 2 Control Parameters 0 0 0 cette 114 9 5 Handling RTOCM EOS a Tensen feeb hee ethene neha dada beam e ae ee Be 117 9 6 Configuration Procedure 0 c cca 117 9 7 Sample Scenarios Using the RTCM API Functions 00000 eee eae 118 9 7 1 Getting or Setting GCLib Configuration in Synchronous Mode 119 9 7 2 Getting or Setting CCLib Configuration in Synchronous Mode 120 9 7 3 Getting or Setting Line Device Configuration in Synchronous Mode 121 9 7 4 Setting Line Device Configuration in Asynchronous Mode 123 9 7 5 Setting Board Device Configuration in Asynchronous Mode IP Technology 124 Handling Service Requests 0 0 ete teens 127 10 1 Service Request Overview 0c teens 127 10 2 Service Request Components 000 ccc eet eee 128 10 3 Service Request Data 0 tees 129 10 4 General Service Request Scenario 1 2 2 0 00 e tee 129 Using Global Call to Implement Call Transfer 0 00000 c cee eee 131 11 1 Introduction to Call Transfer 0 2 0 0 aana 131 Tel Blind Call Transten 2 2240 a e e tale gee odaug eure dhe eet
28. is in the blocked condition but it should not do so in response to the GCEV_BLOCKED event If a call is active typically a GCEV_DISCONNECTED event arrives either just before or just after the GCEV_BLOCKED event at which point the application should drop and release the call indicated by the GCEV_DISCONNECTED event The Global Call term blocked does not refer to the signaling bits indicating a blocked condition as defined in some network interface technologies although the line device may move to a blocked condition as a consequence of the signaling bits indicating a blocked condition At some point the application may receives aGCEV_UNBLOCKED event indicating that the conditions blocking a line device have been removed and the line device has now returned to the unblocked condition The application can once again use any valid function on the line device The reception of the GCEV_BLOCKED and GCEV_UNBLOCKED events may be disabled using the gc_SetConfigData function The default is that these events are enabled However disabling the reception of these events is not recommended since the application will not be notified of these Global Call API for HMP on Windows Programming Guide August 2006 4 4 Note Event Handling critical events In addition if the GCEV_BLOCKED event is disabled some functions will fail with a reason of EGC_INVALIDSTATE which may cause confusion For more information on blocking alarms and the GCEV_BL
29. line device gc_SetUserInfo permits technology specific user information to be defined for the specified line device or call Note The gc_SetUserInfo function is not supported for a board device 7 4 2 Technology Specific Feature Access The ge_Extension function provides a single common interface to access various technology specific features supported by underlying call control libraries This Global Call function utilizes an extension function identifier ext_id to specify the feature The associated technology s Global Call Technology Guide for each call control library lists all the supported extension function identifiers ext_id values and the associated features that are accessible via the gc_Extension function if any By specifying the associated parameter identifiers also described in the associated technology s Global Call Technology Guide and either the target line device or a specific call those features unique to the subject technology may be utilized entirely using the Global Call API Without FTE support a Global Call application requiring this feature support would also have to be written to the specific call control API in addition to the Global Call API For example in an ISDN platform the application may use the gc_Extension function to set D or B channel states As the concept of B and D channels is ISDN specific and inherently foreign to other protocols without FTE support the application wou
30. logical or virtual board or trunk level and the channel level Logical or Virtual Board IP technology or Trunk E1 T1 or ISDN technology Level When the Global Call API recognizes a blocking alarm on condition at the logical or virtual board or trunk level aGCEV_BLOCKED event is generated for the logical or virtual board or trunk device assuming that the device is open AGCEV_BLOCKED event is also generated for all time slots currently open on the logical or virtual board or trunk device assuming that the application is currently unblocked The application will receive a GCEV_BLOCKED event only for the first alarm on condition for a particular line device When the Global Call API recognizes a blocking alarm off condition at the logical or virtual board or trunk level a GCEV_UNBLOCKED event is generated for the logical or virtual board or trunk device assuming that the device is open AGCEV_UNBLOCKED event is also generated for all time slots currently open on the logical or virtual board or trunk device assuming there are no other blocking conditions on the line device The application will receive a GCEV_UNBLOCKED event only for the last alarm off condition for a particular line device Channel Level When the Global Call API recognizes a blocking alarm on condition at the channel level a GCEV_BLOCKED event is generated for the channel assuming that the application is currently unblocked The application will receive a GCEV_BLOCKED e
31. of the associated METAEVENT structure The LDID is retrieved using the gc_GetMetaEvent or the ge_GetMetaEventEx function Call Reference Number A Call Reference Number CRN is a means of identifying a call on a specific line device A CRN is created by the Global Call library when a call is requested by the application thread or network With the CRN approach the application or thread can access and control the call without any reference to a specific physical port or line device CRNs are assigned to both inbound and outbound calls Inbound calls The CRN is assigned via the ge_WaitCall function For more information on gce_WaitCall see the Global Call API Library Reference Outbound calls The CRN is assigned via the ge_MakeCall function For more information on this function see the Global Call API Library Reference This CRN has a single LDID associated with it for example the line device on which the call was made However a single line device may have multiple CRNs associated with it that is more than Global Call API for HMP on Windows Programming Guide August 2006 1 5 3 1 5 4 Product Description one call may exist on a given line A line device can have a maximum of 20 CRNs associated with it At any given instant each CRN is a unique number within a process After a call is terminated and the ge_ReleaseCallEx function is called to release the resources used for the call the CRN is no longe
32. technologies only or set all technologies the configuration of a physical or logical entity dynamically The entity can be a system that is all boards board network interface channel or call e Get El T1 or ISDN technologies only or set all technologies the configuration of a call control library dynamically For example the default call state mask value of a channel can be retrieved or updated with a new value e Query E1 T1 or ISDN technologies only the protocol ID from the given protocol name or CDP parameter ID from the given CDP parameter name In addition the RTCM feature provides Global Call applications with the ability to retrieve configuration parameter information Some of the ways this information can be used include e Efficient network management Global Call API for HMP on Windows Programming Guide August 2006 109 Lal Real Time Configuration Management ntel e Troubleshooting software and hardware e Performance tuning e Dynamic alteration of a target object s behavior based upon past behavior e Generation of status reports e Dynamic configuration of Global Call call modules or call events 9 2 RTCM Components The RTCM comprises three major components the customer application using RTCM the Global Call RTCM which consists of the Global Call RTCM APIs and the Global Call RTCM Manager and the RTCM parameters Figure 25 shows the relationship between these components Figure 25 Relati
33. the Global Call Technology Guide for that technology Figure 5 shows a basic asynchronous call scenario for an incoming call Figure 5 Basic Asynchronous Inbound Call Scenario GlobalCall Application Library Network Technology Incoming Call All Information Received GCEV_OFFERED gc_GetCalllnfo DESTINATION_ADDRESS gc_GetCalllnfo ORIGINATION_ADDRESS Sufficient Information Received gc_AcceptCall GCEV_ACCEPTED gc_AnswerCall GCEV_ANSWERED Alerting Call Answered Global Call API for HMP on Windows Programming Guide August 2006 47 Call State Models intel Figure 6 shows an asynchronous call scenario for an incoming call with call proceeding Figure 6 Incoming Call Scenario with Call Proceeding GlobalCall Application Library Network Technology Incoming Call All Information Received GCEV_OFFERED gc_GetCalllnfo DESTINATION_ADDRESS gc_GetCalllnfo ORIGINATION_ADDRESS Sufficient Information Received gc_CallAck GCACK_SERVICE_PROC Call Proceeding GCEV_CALLPROC gc_AcceptCall Alerting GCEV_ACCEPTED gc_AnswerCall Call Answered GCEV_ANSWERED 48 Global Call API for HMP on Windows Programming Guide August 2006 ntel Call State Models Figure 7 shows an asynchronous call scenario for an incoming call with call acknowledgement and call proceeding controlled by the application This scenario applies to E1 T1 and
34. the gc_ReleaseCallEx function to release all internal resources allocated for the call Network Initiated Termination When a network call termination is initiated an unsolicited GCEV_DISCONNECTED event is generated This event indicates the call was disconnected at the remote end or an error was detected which prevented further call processing The GCEV_DISCONNECTED event causes the call state to change from the current call state to the Disconnected state This event may be received during call setup or after a connection is requested In the Disconnected state the user issues the gc_DropCall function to disconnect the call The ge_DropCall function is equivalent to set hook ON After the remote side is notified about the call being dropped a GCEV_DROPCALL event is generated causing the call state to change to the Idle state In the Idle state the Global Call API for HMP on Windows Programming Guide August 2006 61 Call State Models i ntel gc_ReleaseCallEx function must be issued to release all internal resources committed to servicing the call 3 4 3 4 Call Release Once in the Idle state the call has been disconnected and the application must issue a gc_ReleaseCallEx function to free the line device for another call The gec_ReleaseCallEx function releases all internal system resources committed to servicing the call A GCEV_RELEASECALL event is generated and the call state transitions to the Null state 3 4
35. the initial call state of a line device when it is first opened This state is also reached when a call is released or after the channel is reset If the above conditions are met the application or thread must issue a ge_WaitCall function in the Null state to indicate readiness to accept an inbound call request on the specified line device In the asynchronous mode the ge_WaitCall function must be called only once after the line device 42 Global Call API for HMP on Windows Programming Guide August 2006 Note 3 4 1 3 Note 3 4 1 4 Note Call State Models is opened using the gc_OpenEx function However if the ge_ResetLineDev function was issued ge_WaitCall must be reissued In asynchronous mode it is not necessary to issue gce_WaitCall again after a call is released After ge_WaitCall is issued to wait for incoming calls on a line device it is possible to use gc_makeCall to make an outbound calls on that line device Call Detection The inbound call from the network is received on the line device specified in the ge_WaitCall function but the call has not been offered to the application The technology call control layer typically sends an acknowledgement to the remote side In some configurations this acknowledgement can also be sent by the application when the call is offered At this stage the call is being processed which typically involves allocating resources or waiting for more informa
36. your application that may affect the state of the line or the reporting of events for example dt_settssig dt_setevtmsk or others e The GCEV_BLOCKED and the GCEV_UNBLOCKED events are line related events not call related events These events do not cause the state of a call to change e Before exiting an application Drop and release all active calls using the ge_DropCall and gc_ReleaseCallEx functions Close all open line devices using the ge_Close function Stop the application using the ge_Stop function e Before issuing ge_DropCall you must use the dx_stopch function to terminate any application initiated voice functions such as dx_play or dx_record e In Windows environments although asynchronous models are more complex than the synchronous model asynchronous programming is recommended for more complex applications that require coordinating multiple tasks Asynchronous programming can handle multiple channels in a single thread In contrast synchronous programming requires separate Global Call API for HMP on Windows Programming Guide August 2006 77 Lal Application Development Guidelines ntel z threads Asynchronous programming uses system resources more efficiently because it handles multiple channels in a single thread Asynchronous models let you program complex applications easily and achieve a high level of resource management in your application by combining multiple voi
37. 29 2 2 2 Asynchronous Model with Event Handlers aaua c eee eee eee 30 2 2 3 Asynchronous with Windows Callback Model 0 0000 eee 31 2 2 4 Asynchronous with Win32 Synchronization Model 0 00000 31 2 2 5 Extended Asynchronous Programming Model 020 eee ee eee 31 3 Call State Models 0 0 00 tet eee 33 3 1 Call State Model Overview 00 ccc tees 33 3 2 Basic Call Model 2 40200 e0esend Ole eee teda p a ver bhechtadhecan vee ees 33 3 2 1 Basic Call States at the Inbound Interface 0 00000 cee eee 34 3 2 2 Basic Call States at the Outbound Interface 0 00 cee eee 35 3 2 3 Basic Call States for Call Termination 00 000 eee 35 3 3 Basic Call Model Configuration Options 0 0 00 c eee 36 3 3 1 Call State Configuration 0 0 0 0 ee 36 3 3 2 Call State Event Configuration 0 0 00 cee 37 3 3 3 Call Acknowledgement Configuration 0 00 eee 38 3 3 4 Call Proceeding Configuration 20 00 ee 38 Global Call API for HMP on Windows Programming Guide August 2006 3 Contents i ntel 5 3 4 Basic Call Control in Asynchronous Mode 00 cece eee eee 39 3 4 1 Inbound Calls in Asynchronous Mode 0 000 cece eee 39 3 4 2 Outbound Calls in Asynchronous Mode 000 ccc eee eens 52 3 4 3 Call Termination in Asynchronous Mode 000 cece eee 60 3 4 4 Handling Unsolici
38. Alarm Management System GCAMS Topics include the following Alatin Handling Overview i cs40i6s artritit ERIA EAS EER ERE ERSA 97 Operation and Configuration of GCAMS s isssisisriitasisieseria testent piia 99 Sample Alim SCOS eraro ernan ARLE EEA REAA RA 105 Alarm Handling Overview Global Call alarms originate from alarm source objects ASO An alarm source object can be a network library a call control library or it can reside within a call control library Some alarm source objects are for internal Global Call use only and are not available to the application There are basically two sources of Global Call alarms e Layer 1 alarms physical alarms e Logical alarms such as remote side out of service or layer 2 or layer 3 out of service The portion of the Global Call call control library that manages alarms is called the Global Call Alarm Management System GCAMS GCAMS is initialized automatically when Global Call is started GCAMS provides Global Call applications with the ability to receive extensive alarm information Some of the ways this information can be used include e Managing the network e Troubleshooting hardware e Monitoring line quality e Working with the central office to solve line problems e Generating status reports e Modifying alarm source object properties and characteristics based on alarm history e Manual handling of alarms for drop and insert applications The following secti
39. CALL GCST_ALERTING Me r A GCST_IDLE GCEV_CONNECTED GCEV_RELEASECALL GCST_CONNECTED GCST_NULL Transferred to Party Party C the rerouting call is same as new incoming call except GCEV_DETECTGED GCEV_OFFERED with a flag indicating a transfer call Global Call API for HMP on Windows Programming Guide August 2006 135 E Using Global Call to Implement Call Transfer ntel 3 Note The state diagrams in Figure 38 Figure 39 and Figure 40 apply to the supervised transfer case represented in Figure 35 Figure 38 Call State Model for Supervised Transfer at Party A Transferring Party Party A Call 1 Call 2 GCEV_INIT_XFER or GCEV_INIT_XFER_FAIL GCEV_INIT_XFER_REJ GCEV_INVOKE_XFER_REJ GCEV_INVOKE_XFER_FAIL GCST_CONNECTED or GCST_HOLD GCST_CONNECTED or GCST_HOLD GCEV_INVOKE_ Gcey_INVOKE_XFER_ACCEPTED GCEV DISCONNECTED XFER_FAIL XFER CMPLT Ca _ v _ _ s GCST_INVOKE_ GCST_DISCONNECTED XFER_ACCEPTED N pi L _AGCEV_INVOKE_XFER GCEV_INVOKE_XFER GCEV_DROPCALL GCST_IDLE GCST_INVOKE_XFER GCEV_RELEASECALL GCEV_DISCONNECTED XFER CMPLT GCST_NULL GCST_DISCONNECTED GCEV_DROPCALL GCST_IDLE GCEV_RELEASE GCST_NULL 136 Global Call API for HMP on Windows Programming Guide August 2006 n Using Global Call to Implement Call Transfer Figure 39 Call State Model for Supervised Transfer at Party B Transferred Party Party B Call 1 Call 3
40. CK parm ID can be assigned one of the following values of type GC_VALUE_INT e GCCONTROL_APP application controlled e GCCONTROL_TCCL technology call control layer controlled See the Global Call API Library Reference for more information on the ge_SetConfigData function Call Proceeding Configuration When an incoming call is received and all the information required to proceed with the call is available an indication that the call is proceeding is usually sent to the remote side for informational purposes Either the technology call control layer or the application can be configured to send a call proceeding indication to the remote side This can be done by issuing the gc_SetConfigData function The set ID used in this context is GCSET_CALL_CONFIG and the relevant parm ID is GCPARM_CALLPROC Specify whether call proceeding indication is provided by the application or the technology call control layer The GCPARM_CALLPROC parm ID can be assigned one of the following values of type GC_VALUE_INT e GCCONTROL_APP application controlled e GCCONTROL_TCCL technology call control layer controlled See the Global Call API Library Reference for more information on the ge_SetConfigData function Global Call API for HMP on Windows Programming Guide August 2006 Note Caution 3 4 1 3 4 1 1 Call State Models Basic Call Control in Asynchronous Mode This section describes and illustrates the basic call mode
41. Call Progress Tones on a Per Board Basis 7 2 1 Call Progress Analysis Definition Pre connect call progress determines the status of a call connection that is busy no dial tone no ringback etc and can also include the frequency detection of Special Information Tones SIT such as an operator intercept Post connect call analysis determines the destination party s media type that is voice fax or answering machine The term call progress analysis CPA is used to refer to call progress and call analysis collectively Global Call API for HMP on Windows Programming Guide August 2006 87 Call Control 7 2 2 7 2 3 88 Note intel Configuring Default Call Progress Analysis Parameters Call Progress Analysis CPA is characterized by parameters such as CaSignalTimeout the maximum time to wait to detect a call progress tone CaAnswerTimeout the maximum time that call analysis will wait for ringback to stop and others that define CPA behavior Depending on the technology you are using the default values of CPA parameters may be configurable in the CONFIG file corresponding to the board If this is the case the required information is documented in the corresponding Global Call Technology Guide When a voice resource has been attached using either gc_OpenEx or gc_AttachResource by default the DM3 host runtime library enables the detection of BUSY RINGING and SIT tone that is pre connect call progress eve
42. Call Real Time Configuration Manager RTCM Topics include the following Real Time Configuration Manager Qverview i125 4005 b008 ce een a toiee bestia 109 RICM Components 61 6 e259 Keo ee Roe ROH SAVES SRO SPREE EH EHO RAS EERE 110 emg RUC POr renos kearen Make ds ee eser dhe geed cakes 112 Getting and Setting Parameter nformauon s oc2se40isacecsegecs wae siagers ESk 114 Handime RICM Brera cocks oes he eyes tapes Ee Eee ees Owe ERMES 117 Conheuration Proced t csosrrercrierrr taner keter atei kiar Ae Ea 117 Sample Scenarios Using the RTCM API Functions 000 118 9 1 Real Time Configuration Manager Overview The Global Call Real Time Configuration Management RTCM system manages run time configuration for Global Call components The RTCM feature is used when the application needs to retrieve E1 T1 and ISDN technology only or modify all technologies configuration data If the configuration data is not modified the application uses the initial values for the configuration Note Not all technologies support the RTCM feature Refer to the appropriate Global Call Technology Guide to determine if RTCM is supported The Global Call RTCM system allows applications to e Get El T1 or ISDN technologies only or set all technologies the configuration of a protocol dynamically For example the default values of CDP parameters can be retrieved or updated with new values e Get El T1 or ISDN
43. CallInfo function If more information is required the application may also request more address information using the gc_CallAck GCACK_SERVICE_INFO function Since an acknowledgement was already sent out no acknowledgement is sent to the remote side at this time When the additional information is received the GCEV_MOREINFO event is generated If more information is still required the gc_ReqMoreInfo function is issued to request more information When the additional information is received the GCEV_MOREINFO event is generated again When all the required information is received the application may send a call proceeding indication to the remote side by issuing the ge_CallAck GCACK_SERVICE_PROC function Otherwise the application can choose to accept or answer the call Scenario 4 In this scenario the application is configured to acknowledge the incoming call and the technology call control layer is configured to send a call proceeding indication after sufficient information has been received When an incoming call is detected the call is offered to the application regardless of the amount of information available When the call is in the Offered state after generation of the unsolicited GCEV_OFFERED event the application sends an acknowledgement for the incoming call by issuing a ge_CallAck GCACK_SERVICE_INFO The application may selectively retrieve call information such as Destination address and Origination address caller ID
44. D gt Offered GCEV_OFFERED state GCEV_DISCONNECTED gt Disconnected state GCEV_DROPCALL gt Idle state GetMorelnfo GCST_GETMOREINFO t Maskable Previous Offered Next GCEV_ANSWERED gt Connected state GCEV_MOREINFO gt GetMorelnfo state GCEV_ACCEPT gt Accepted state GCEV_CALLPROC gt CallRouting state GCEV_DISCONNECTED gt Disconnected state GCEV_DROPCALL gt Idle state gc_ReqMorelnfo gc_CallAck gc_AnswerCall gc_AcceptCall gc_DropCall GCEV_DISCONNECTED GCEV_DROPCALL GCEV_ACCEPT GCEV_ANSWERED GCEV_MOREINFO or GCEV_CALLPROC t Applies to E1 T1 and ISDN technology only Global Call API for HMP on Windows Programming Guide August 2006 41 Call State Models Table 6 Asynchronous Inbound Call State Transitions intel State Description Previous Next State Valid Call State Transition Functions Call Transition Events Null GCST_NULL Not Maskable Previous Idle Next gc_WaitCall gt Null state gc_ResetLineDev gt Null state GCEV_OFFERED gt Offered state GCEV_DETECTED gt Detected state gc_WaitCall GCEV_DETECTED GCEV_OFFERED Offered GCST_OFFERED Not Maskable Previous Null Detected Next GCEV_ANSWERED gt Connected state GCEV_ACCEPT gt Accepted state GCEV_CALLPROC gt CallRouting state GCEV_MOREINFO gt GetMorelnfo state t GCEV_DISCONNECTED gt Disconnected
45. GCLib These parameters are common across multiple technologies such as protocol name and ID call event mask and the call state mask of a line device Although the GCLib module maintains many of the GCLib defined parameters some parameters such as calling number and call info are maintained in other modules such as CCLib Parameters in CCLib Module parameters that are defined and maintained in the CCLib module The CCLib may maintain some GCLib defined parameters such as calling number and call info See the appropriate Global Call Technology Guide for more information about configurable parameters Parameters in Protocol Module parameters that are defined and maintained in a protocol module One example of protocol parameters are country dependent parameters CDP See the appropriate Global Call Technology Guide for more information about configurable parameters Parameters in Firmware Module parameters that are defined and maintained in a firmware module See the appropriate Global Call Technology Guide for more information about configurable parameters To access the value of a parameter the application must specify a four part name consisting of two pairs target object type target object ID and set ID parameter ID Target object type and target object ID This pair represents the target object See Section 1 5 4 Target Objects on page 25 for more information Both the target object type and target object ID are specif
46. ID and parameter ID the parameter value size must match the parameter data type For example a Jong data type has four bytes A character string value is terminated by a NULL 0 The Global Call utility functions must be used to allocate or deallocate the GC_PARM_BLK memory insert a parameter or retrieve a parameter See the Global Call API Library Reference for more information on the utility functions gc_util_xxx functions The customer application should not configure the same parameter more than once in one single function call otherwise the results will be undetermined Also the customer application must only configure one target object in one function call Otherwise the mixture of parameters of different target objects in the GC_PARM_BLK will be rejected by the Global Call RTCM API functions Control Parameters The Global Call RTCM API control parameters ensure the efficiency of the retrieve E1 T1 and ISDN technologies only or update IP technology configuration process and that the application program is not blocked The application can specify e the programming mode e the timeout interval for completing the retrieval or update Global Call API for HMP on Windows Programming Guide August 2006 intel 9 4 2 1 Note Real Time Configuration Management e the update condition that is whether the update should occur either at the Null call state or immediately when updating the parameters of a target object wi
47. ISDN technologies only Figure 7 Call Acknowledgement and Call Proceeding Done at the Application Layer GlobalCall Application Library Network Technology Incoming Call GCEV_OFFERED gc_GetCalllnfo DESTINATION_ADDRESS Acknowledgement gc_GetCalllnfo ORIGINATION_ADDRESS and Request for gc_CallAck GCACK_SERVICE_INFO More Address Information GCEV_MOREINFO More Information gc_GetCalllnfo DESTINATION_ADDRESS More Information New Information Buffered gc_ReqMorelnfo DESTINATION_ADDRESS GCEV_MOREINFO gc_GetCalllnfo DESTINATION_ADDRESS Sufficient Information Received gc_CallAck GCACK_SERVICE_PROC Call Proceeding GCEV_CALLPROC gc_AcceptCall Alerting GCEV_ACCEPTED gc_AnswerCall Call Answered GCEV_ANSWERED Global Call API for HMP on Windows Programming Guide August 2006 49 Call State Models i ntel 50 Figure 8 Figure 8 shows an asynchronous call scenario for an incoming call with call proceeding controlled by the application with the minimum information configuration This scenario applies to E1 T1 and ISDN technologies only Call Proceeding Done by the Application Layer with Minimum Information Configured GlobalCall Application Library Network Technology Incoming Call GCEV_DETECTED Acknowledgement and Request for More Address Information More Information Minimum Information Received GCEV_OFFERED gce_GetCalllnfo
48. LIB_SYSTEM GCTGT_CCLIB_SYSTEM GCTGT_PROTOCOL_SYSTEM and GCTGT_FIRMWARE_SYSTEM The function returns invalid target type The gc_SetConfigData function must be called in synchronous mode for these target types The original GC_PARM_BLK data block is not changed after the ge_SetConfigData function returns Timeout Option When using IP technology the timeout option provided by the timeout parameter in the gc_SetConfigData function is not supported and should be set to 0 When using E1 T1 and ISDN technology the following apply e The customer application can specify the timeout for completing the parameter retrieval or update The gec_GetConfigData and ge_SetConfigData functions support the timeout option only in synchronous mode When a timeout occurs in the synchronous mode the function returns an EGC_TIMEOUT error to the application The timeout option is ignored if the function is executed in asynchronous mode e The function call is stopped immediately when a timeout occurs When accessing multiple parameters in a single function call some but not all parameters may have been retrieved or updated before the timeout e A timeout value selected to be less than or equal to zero indicates an infinite timeout When the gce_SetConfigData function has an infinite timeout set and is updated at the Null call state this thread is blocked if the target object still has any active call The customer application can avoid th
49. N technologies only Scenario 1 Application Notified of First and Last Blocking Alarm In this scenario the application wants to be notified of only the first and last blocking alarm events The default blocking configuration is acceptable See Figure 22 If both aGCEV_ALARM and a GCEV_BLOCKED or GCEV_UNBLOCKED event are generated for an alarm the order in which these events are sent to the application is not guaranteed Global Call API for HMP on Windows Programming Guide August 2006 105 Alarm Handling i ntel The steps are 1 Configure all known call control libraries set all alarms to notify and set flow control to first and last blocking 2 Open a line device The line device s configuration will be inherited from its network ASO which has already been initialized Figure 22 Notification of First and Last Blocking Alarm Application GlobalCall gc_NotifyAll ASO1 Alarm Source Object ASO gc_NotifyAll ASO2 gc_NotifyAll ASOn gc_SetAlarmFlow ASO1 gc_SetAlarmFlow ASO2 gc_SetAlarmFlow ASOn l gc_Open Ex First Blocking Alarm Occurred GCEV_BLOCKED Second Blocking Alarm Occurred First Unblocking Alarm Occurred Second Unblocking Alarm Occurred GCEV_UNBLOCKED GCEV_ALARM Note indicates that the function should be repeated for all ASO s Note The function calls for alarm processing are not shown 106 Global Call API
50. OCKED and GCEV_UNBLOCKED events see Section 8 2 1 Generation of Events for Blocking Alarms on page 99 A GCEV_UNBLOCKED event will be generated when opening a virtual board device A GCEV_BLOCKED event will also be generated if there are blocking alarms on the virtual board and the corresponding GCEV_UNBLOCKED event will be generated when the blocking alarms clear The application must be prepared to handle these events Event Retrieval All events are retrieved using the current Standard Runtime Library SRL event retrieval mechanisms see the Standard Runtime Library API Programming Guide for details including event handlers The ge_GetMetaEventt function or for Windows extended asynchronous models the ge_GetMetaEventEx function maps the current SRL event into a metaevent A metaevent is a data structure that explicitly contains the information describing the event This data structure provides uniform information retrieval among all call control libraries For Global Call events the structure contains Global Call related information CRN and line device used by the application For events that are not Global Call events the device descriptor the event type a pointer to variable length event data and the length of the event data are available through the METAEVENT structure Since all the data associated with an event is accessible via the METAEVENT structure no additional SRL calls are required to access the event data
51. PARM_BLK data structure with the appropriate set ID parm ID value size and value if applicable by calling the Global Call utility functions gc_util_insert_parm_ref or gc_util_insert_parm_val See the Global Call API Library Reference for more information 120 Global Call API for HMP on Windows Programming Guide August 2006 intel 9 7 3 Note 4 Real Time Configuration Management Call the gc_GetConfigData or gc_SetConfigData function with target_type GCTGT_CCLIB_SYSTEM target_id CCLib ID time_out 0 mode EV_SYNC If the gc_GetConfigData function returns successfully then obtain the individual parameter data by calling the gc_util_get_next_parm function If an error occurs call the gc_ErrorInfo function to find the error and correct it Getting or Setting Line Device Configuration in Synchronous Mode This section applies to E1 T1 and ISDN technologies only The Global Call RTCM feature also allows the customer application to retrieve or change the default configuration of a line device in synchronous mode Synchronous mode can be used effectively in any of the following cases The request is to retrieve parameters The request is to update parameters that are NOT call related The request is to update parameters that are call related but there is no active call on the target object The target type is neither GCTGT_FIRMWARE_CHAN nor GCTGT_FIRMWARE_NETIF that is the p
52. Procedure 000 0c eee 118 Getting or Setting GCLib Configuration in Synchronous Mode 00000 119 Getting or Setting CCLib Configuration in Synchronous Mode 00 0005 120 Getting or Setting Line Device Configuration in Synchronous Mode 122 Setting Line Device Configuration in Asynchronous Mode E1 T1 and ISDN Technology 123 Setting Board Device Configuration in Asynchronous Mode IP Technology 124 Service Request Architecture 20 00 cect tenes 128 Generic Service Request Operation 000 ccc eee 130 Blind Call Transfer Unsupervised Transfer 00 00 ccc eee 132 Supervised Call Transfer 0 0 0 cent tenet ene eee 132 Call State Model for Blind Call Transfer at Party A 0 0 000 c cee eee 134 Call State Model for Blind Transfer at Party B nananana 0000 cece ee ee 135 Call State Model for Supervised Transfer at Party A a na nauau 00 cece eee 136 Call State Model for Supervised Transfer at Party B 0 0 000 cee eee 137 Call State Model for Supervised Transfer at Party C 0 000 ccc ee 138 Global Call API for HMP on Windows Programming Guide August 2006 7 Contents ntel 8 Global Call API for HMP on Windows Programming Guide August 2006 ntel M Contents Tables ANoOoaRWND Call Control Library States 0 0 0 tte ee 23 Supported Target Types 0 0 cece eee 25 Target Types and Target
53. SERTER Optional Note In Figure 4 the GetMorelInfo state and all transitions to from that state apply to E1 T1 and ISDN technologies only 40 Global Call API for HMP on Windows Programming Guide August 2006 Table 6 Asynchronous Inbound Call State Transitions Call State Models State Description Previous Next State Valid Call State Transition Functions Call Transition Events Accepted GCST_ACCEPTED Maskable Call Routing GCST_CALLROUTING Maskable Previous Offered GetMorelnfo t CallRouting Next GCEV_ANSWERED gt Connected state GCEV_DISCONNECTED gt Disconnected state GCEV_DROP CALL gt Idle state Previous Offered GetMorelnfo t Next GCEV_ANSWERED gt Connected state GCEV_ACCEPT gt Accepted state GCEV_DISCONNECTED gt Disconnected state GCEV_DROPCALL gt Idle state gc_AnswerCall gc_DropCall gc_AnswerCall gc_AcceptCall gc_DropCall GCEV_DISCONNECTED GCEV_DROPCALL or GCEV_ANSWERED GCEV_DISCONNECTED GCEV_DROPCALL GCEV_ACCEPT or GCEV_ANSWERED Connected Previous Accept Offered gc_DropCall GCEV_DISCONNECTED GCST_CONNECTED GetMorelnfo t CallRouting GCEV_DROPCALL Not Maskable Dialing SendMorelnfo t Proceeding Alerting Next GCEV_DISCONNECTED gt Disconnected state GCEV_DROPCALL gt Idle state Detected Previous Null gc_DropCall GCEV_DISCONNECTED GCST_DETECTED Next GCEV_DROPCALL Maskable GCEV_OFFERE
54. Standard Runtime Library A Intel Dialogic library that contains C functions common to all Intel Dialogic devices a data structure to support application development and a common interface for event handling supervised transfer A call transfer in which the person transferring the call stays on the line announces the call and consults with the party to whom the call is being transferred before the transfer is completed synchronous function Synchronous functions block an application or process until the required task is successfully completed or a failed error message is returned synchronization objects Windows executive objects used to synchronize the execution of one or more threads These objects allow one thread to wait for the completion of another thread and enable the completed thread to signal its completion to any waiting thread s Threads in Windows are scheduled according to their priority level 31 levels are available and run until one of the following occurs 1 its maximum allocated execution time is exceeded 2 a higher priority thread marked as waiting becomes waiting or 3 the running thread decides to wait for an event or an object 148 Global Call API for HMP on Windows Programming Guide August 2006 intel synchronous mode Programming characterized by functions that run uninterrupted to completion Synchronous functions block an application or process until the required task is successfully completed or a fa
55. TED e GCMSK_DIALING e GCMSK_PROCEEDING e GCMSK_REQMOREINFO for E1 T1 and ISDN technologies only Using the ge_SetConfigData function with a target_ID of a board device to mask events for all devices associated with a board is not supported Call state events can be masked on a per line device basis only Global Call API for HMP on Windows Programming Guide August 2006 37 Call State Models i ntel 3 3 3 3 3 4 38 Note See the Global Call API Library Reference for more information on the ge_SetConfigData function Call Acknowledgement Configuration This functionality applies to E1 T1 and ISDN technologies only When an incoming call is received an acknowledgement is typically sent to the remote side to indicate that the call was received In some technologies if the incoming call does not have sufficient information this acknowledgement also indicates to the remote side that more information is required to proceed with the call see Section 3 4 1 8 Overlap Receiving for more information Either the technology call control layer or the application can be configured to send the acknowledgement This configuration can be set by the application issuing the gc_SetConfigData function The set ID used in this context is GCSET_CALL_CONFIG and the relevant parm ID is GCPARM_CALLACK Specify whether call acknowledgement is provided by the application or the technology call control layer The GCPARM_CALLA
56. TGT_CCLIB_SYSTEM t CCLib ID Call control library module target object GCTGT_GCLIB_NETIF Global Call Line device ID Network interface target object in Global Call Library module GCTGT_CCLIB_NETIF Global Call Line device ID Network interface target object in call control library module GCTGT_GCLIB_CHAN Global Call Line device ID Channel target object in Global Call library module GCTGT_CCLIB_CHAN Global Call Line device ID Channel target object in call control library module t For E1 T1 and ISDN technologies only Target types that can only be used by functions issued in synchronous mode If a function uses one of these target types in asynchronous mode an error will be generated The functions that can use these target types are gc_GetConfigData E1 T1 and ISDN technologies only g e_SetConfigData gc_ReqService and gc_RespService 26 Global Call API for HMP on Windows Programming Guide August 2006 Product Description Table 3 Target Types and Target IDs Continued Target Type Target ID Description GCTGT_GCLIB_CRN Global Call CRN CRN target object in Global Call library module GCTGT_CCLIB_CRN Global Call CRN CRN target object in call control library module t For E1 T1 and ISDN technologies only Target types that can only be used by functions issued in synchronous mode If a function uses one of these target types in asynchronous mode an error will be gener
57. T_ALERTING Maskable Dialing GCST_DIALING Not Maskable Previous Proceeding Dialing SendMorelinfo t Next GCEV_CONNECTED gt Connected state GCEV_DISCONNECTED gt Disconnected state GCEV_DROPCALL gt Idle state Previous Null Next GCEV_CONNECTED gt Connected state GCEV_ALERTING gt Alerting Delivered state GCEV_PROCEEDING gt Proceeding state GCEV_REQMOREINFO gt SendMorelnfo state t GCEV_SENDMOREINFO gt SendMorelnfo state t GCEV_DISCONNECTED gt Disconnected state GCEV_DROPCALL gt Idle state gc_DropCall gc_SendMorelnfo t gc_DropCall GCEV_DISCONNECTED GCEV_DROPCALL GCEV_CONNECTED GCEV_CONNECTED GCEV_ALERTING GCEV_REQMOREINFO fT GCEV_PROCEEDING GCEV_DISCONNECTED GCEV_DROPCALL Null GCST_NULL Not Maskable Proceeding GCST_PROCEEDING Maskable Previous Idle Next gc_ResetLineDev gt Null GCEV_DIALING gt Dialing state GCEV_DETECTED gt Detected state Previous Dialing SendMorelnfo t Next GCEV_ALERTING gt Alerting Delivered state GCEV_CONNECTED gt Connected state GCEV_DISCONNECTED gt Disconnected state GCEV_DROPCALL gt Idle state gc_MakeCall gc_DropCall GCEV_DIALING GCEV_DISCONNECTED GCEV_DROPCALL GCEV_CONNECTED GCEV_ALERTING SendMorelnfo GCST_SENDMOREINFO t Maskable Previous Dialing Next GCEV_CONNECTED gt Connected state GCEV_PROCEEDING gt Proceeding
58. _PREONLY_SIT GCPV_ENABLE GCPV_ENABLE GC_CA_ENABLE_ALL The gc_SetConfigData method of setting call progress analysis on a per channel basis is an enhancement over using the gec_SetParm with the GCPR_MEDIADETECT and or GCPR_CALLPROGRESS parameters Applications should not use both the ge_SetConfigData method and the ge_SetParm method on the same line device If both methods are used the gc_SetConfigData method takes precedence Setting Call Analysis Attributes on a Per Channel Basis In addition to enabling and disabling call progress analysis on a per channel basis certain call analysis attributes can be configured on a per channel basis using the gc_SetConfigData function The relevant function parameter values in this context are target_type GCTGT_CCLIB_CHAN target_id the line device target_datap a pointer to a GC_PARM_BLK structure that contains the following parameter set ID and parameter IDs e SetId CCSET_CALLANALYSIS e ParmId Any of the values described in Section 7 2 4 Setting Call Analysis Attributes on a Per Call Basis on page 90 Customizing Call Progress Tones on a Per Board Basis When using Digital Network Interfaceboards an application can create delete and query call progress tones on a per board device basis using the dx_createtone dx_deletetone and dx_querytone functions and the associated TONE_DATA structure in the Voice API See the Voice API Programming G
59. a network interface device that has CAS or R2 MF loaded Likewise if a voice device is not routable it cannot be used in a ge_AttachResource call While a network interface protocol cannot be determined programmatically the dx_getfeaturelist function provides a programmatic way of determining voice capability so that the application can make decisions Global Call API for HMP on Windows Programming Guide August 2006 n Application Development Guidelines 5 3 2 2 Using Device Handles Flexible Routing When using Digital Network Interface boards application performance may be a consideration when opening and closing devices using Global Call If an application must use Global Call to dynamically open and close devices as needed it can impact the application s performance One way to avoid this is to open all devices during application initialization and keep them open for the duration of the application closing them only at the end 5 3 2 3 Multi Threading and Multi Processing Flexible Routing When using Digital Network Interface boards the R4 APIs support multi threading and multi processing with some restrictions on multi processing as follows e One specific channel can only be opened in one process at a time There can however be multiple processes accessing different sets of channels In other words ensure that each process is provided with a unique set of devices to manipulate e Ifa channel was opened in p
60. a Per Call Basis section Updated to indicate that PAMD_QUAL2TMP is not supported and to provide a pointer to a related Tech Note Debugging chapter Added reference to the Runtime Trace Facility RTF Reference chapter in the Intel Dialogic System Diagnostics Guide 05 2409 002 October 2005 Global change Added support for protocols that can be run on the E1 or T1 interfaces provided by Intel NetStructure Digital Network Interface boards Global change Updates to recognize the Intel NetStructure brand Starting Call Control Libraries section Added note about loading only the required call control libraries to keep the required memory footprint small Overlap Sending section Explicitly mentioned ISDN in the list of technologies that do not have messages to request more information Configuring Default Call Progress Analysis Parameters section Added a note that pre connect call progress is enabled by default regardless of the CPA setting in the CONFIG file Real Time Configuration Management chapter Fixed several references to gc_util_insert_val and gc_util_insert_ref which should be gc_util_insert_parm_val and gc_util_insert_parm_ref Supervised Transfers section Updated the call termination figure and added note to describe the unsolicited GCEV_CONNECTED event that is generated for a call when the new call being set up is terminated 05 2409 001 April 2005 Initial version of documen
61. a custom call control library that is not supported by Global Call See the Global Call API Library Reference for more information about the gc_Start function Invoking ge_Start NULL loads all call control libraries and consequently the memory footprint includes memory that is allocated for all call control libraries To reduce the memory footprint selective loading of call control libraries is recommended For more information and an example see the ge_Start function in the Global Call API Library Reference Call Control Library States The initial state of all the call control libraries is the Configured state When a call control library is successfully started the library will be in the Available state If the call control library fails to start the library will be in the Failed state as shown in the diagram below If the call control library is not started it remains in the Configured state Global Call API for HMP on Windows Programming Guide August 2006 In Product Description Figure 3 Call Control Library States CONFIGURED gc_Start Start Start Successful Failed AVAILABLE FAILED Table 1 describes the different states of a call control library Table 1 Call Control Library States 1 5 State Description Configured A library that is supported by Global Call is considered a configured library Available A library that has been successfully started is considered to be available for use by a
62. ace and owns resources such as threads files and dynamically allocated memory Code in the address space for a process is executed by a thread Each process comprises at least one thread which is the component that Windows actually schedules for execution When an application is launched Windows starts a process and a primary thread Windows processes 1 are implemented as objects and accessed using object services 2 can have multiple threads executing in their address space 3 have built in synchronization for both process objects and thread objects Unlike other operating systems Windows does not use a parent child relationship with the processes it creates PSI Protocol State Information file used by the PDKRT to define a specific protocol PSTN See Public Switched Telephone Network Global Call API for HMP on Windows Programming Guide August 2006 147 intel Public Switched Telephone Network PSTN Refers to the worldwide telephone network accessible to all those with either a telephone or access privileges QSIG QSIG is a protocol for Integrated Services Digital Network ISDN communications based on the Q 931 standard It is used for signaling between digital private branch exchanges PBXs QSIG is employed in voice over IP VoIP networks virtual private networks VPNs and high speed multi application networks R2 MFC An international signaling system that is used in Europe South America and the Far East to permit
63. ake note of the following flexibility that exists for the ge_OpenEx function when opening a Global Call line device on Digital Network Interface boards e Due to the nature of the DM3 architecture the protocol name is irrelevant at the time of opening the Global Call line device that is the protocol name is ignored Also when using R4 with boards based on the DM3 architecture all protocols are bi directional You do not need to dynamically open and close devices to change the direction of the protocol e Itis not necessary to specify a voice device name when opening a Global Call line device If you specify the voice device name the network interface device is automatically associated Global Call API for HMP on Windows Programming Guide August 2006 81 a Application Development Guidelines l ntel A Note 82 with the voice device they are attached and routed on the TDM bus If you do not specify the voice device name when you open the Global Call line device you can separately open a voice device and then attach and route it to the network interface device For boards that use the DM3 architecture in a flexible routing configuration only the network device name is required The following procedure shows how to initialize Global Call when using Digital Network Interface boards In Windows use the sr_getboardcnt function with the class name set to DEV_CLASS_DTI and DEV_CLASS_VOICE to determine the number of network and
64. ality When an error occurs Global Call provides functions that enable an application to retrieve more information about the error See Chapter 6 Error Handling for more information Global Call API for HMP on Windows Programming Guide August 2006 1 3 1 3 1 Product Description Event Handling Functionality Provides the ability to handle and process events including the ability to disable and enable events and to retrieve event information See Chapter 4 Event Handling for more information Global Call Alarm Management System GCAMS Provides the ability to manage alarms GCAMS provides Global Call applications with the ability to receive extensive alarm information that can be used to troubleshoot line problems See Chapter 8 Alarm Handling for more information Real Time Configuration Management RTCM Allows the modification of call control and protocol elements in real time providing a single common user interface for configuration management See Chapter 9 Real Time Configuration Management for more information Global Call Service Request GCSR Enables an application to send a request for a service to a remote device Examples of the types of services that this feature supports are device registration channel setup call setup information requests or other kinds of requests that need to be made between two devices across the network See Chapter 10 Handling Service Requests for more inform
65. all model allows the application to place a call on hold The Global Call API provides the following functions to place a call on hold and subsequently to retrieve the call on hold gc_HoldCall place a call on hold gc_RetrieveCall retrieve a call from hold Global Call API for HMP on Windows Programming Guide August 2006 65 Call State Models i ntel The ge_HoldCall function places an active call in the On hold GCST_ONHOLD state The gc_RetrieveCall function retrieves the call from the GCST_ONHOLD state and returns it to the Connected GCST_CONNECTED state Figure 18 illustrates the transition between call states when a call is put on hold and then retrieved Figure 18 Call State Transitions for Hold and Retrieve 3 5 4 3 5 4 1 66 Note gc_HoldCall C state ch1 Connected state ch1 Onhold gc_RetrieveCall Calls in the On hold state must be returned to the Connected state before they can be dropped Calls are dropped following the Basic Call scenario See Section 3 4 Basic Call Control in Asynchronous Mode for more information Call Transfer This section describes the different types of call transfer Topics include e Call Transfer Overview e Supervised Transfers e Unsupervised Transfers Call Transfer Overview There are two types of call transfers Supervised transfers the person transferring the call stays on the line announces the call and consults with the part
66. ally ringing This GCEV_ALERTING event changes the call state to the Alerting state Call Connected When the called party immediately accepts the call such as a call directed to a FAX or voice messaging system a GCEV_CONNECTED event is generated to indicate that the connection was Global Call API for HMP on Windows Programming Guide August 2006 3 4 2 7 Note 3 4 2 8 Call State Models established This event changes the call to the Connected state In the Connected state the call is connected to the called party and call charges begin When the call is answered the remote end makes the connection a GCEV_CONNECTED event changes the call to the Connected state In the Connected state the call is connected to the called party and call charges begin The GCEV_CONNECTED event indicates successful completion of the gec_MakeCall function Overlap Sending This functionality applies to E1 T1 and ISDN technologies only In the Dialing state if the remote side requests more information such as the destination address the GCEV_REQMOREINFO event is generated and the call transitions to the SendMoreInfo state The ge_SendMoreInfo function is issued to send more information If the remote side still requests more information the GCEV_REQMOREINFO event is generated again Once the remote side has received sufficient information it indicates that the call is proceeding and accepts or answers the call Some technologies such
67. an disconnect the call prior to establishing a connection that is while the call setup is in progress Thus the call does not have to be in the connected state before it can be disconnected The user must respond by dropping the call and releasing the internal resources allocated for the call Global Call API for HMP on Windows Programming Guide August 2006 35 Call State Models i ntel 3 3 3 3 1 36 Call Idle GCST_IDLE This state indicates that the local user has dropped the call This may be a termination initiated by the local user or a response to the remote side disconnecting the call While the call no longer exists internal system resources committed to servicing the call are still present The user must release these resources as they are no longer required Basic Call Model Configuration Options Depending on the specific technology the following options are available for configuring the technology call control layer or the application Call State If a state is disabled the corresponding call state event is also disabled Call State Event Call state transition events are masked so that the events are not generated Call Acknowledgement An acknowledgement is sent to indicate to the remote side that the call has been received but more information is required to proceed with the call Call Proceeding Call proceeding information is sent to the remote side when an incoming call is received and all the informati
68. andle Global Call events Chapter 6 Error Handling describes the error handling facilities provided by Global Call Chapter 5 Application Development Guidelines provides guidelines when developing applications that use Global Call Chapter 7 Call Control describes basic call control capabilities resource routing and feature extensions provided by Global Call Chapter 8 Alarm Handling describes how Global Call can be used to handle alarms Chapter 9 Real Time Configuration Management describes how Global Call can be used for real time configuration of parameters associated with the interface Chapter 10 Handling Service Requests describes the generic service request facility provided by Global Call Chapter 11 Using Global Call to Implement Call Transfer provides general information on the implementation of unsupervised blind and supervised call transfer Chapter 12 Building Applications provides guidelines for building applications that use the Global Call software Chapter 13 Debugging provides pointers to where technology specific debugging information can be obtained The Glossary provides a definition of terms used in this guide Related Information Refer to the following sources for more information Global Call API Library Reference Global Call E1 T1I CAS R2 Technology Guide Global Call ISDN Technology Guide Global Call API for HMP on Windows Programming Gu
69. arameter of the high level target object may also cause the same parameter of the newly created lower level target object to be updated Consult the appropriate Global Call Technology Guide for information about parameter usage Parameter Definitions GCLib or CCLib parameter descriptions can be found in the Global Call API Library Reference Other target objects and their associated set IDs and parameters are described in the appropriate Global Call Technology Guide The Global Call Technology Guides also includes which header files are required All configurable parameters are of the following type Static parameters that are predefined in header files with a fixed set ID and parameter ID Every parameter is further defined by the software module as one of the following update conditions read only parameter is not allowed to be changed by the application update immediately parameter is updated immediately upon a set request update at null call state parameter is only allowed to be updated at the Null call state that is there are no active calls This parameter is updated after a set request is made and when the call state is Null See Section 9 4 Getting and Setting Parameter Information on page 114 and the appropriate Global Call Technology Guide for detailed information Global Call API for HMP on Windows Programming Guide August 2006 113 Lal Real Time Configuration Management ntel 9 4 9 4 1 9 4 2
70. arameters are not maintained in the firmware Figure 29 shows the procedure for getting or setting line device configuration in synchronous mode Global Call API for HMP on Windows Programming Guide August 2006 121 al Real Time Configuration Management ntel Figure 29 Getting or Setting Line Device Configuration in Synchronous Mode ee GlobalCall Application Library gc_OpenEx Open a Line Device gc_QueryConfigData Find the Set ID and Parm ID of the Parameters gc_util_insert_parm_ref or Create Target Data for Retrieving or gc_util_insert_parm_val Updating Parameters of the Line Device gc_GetConfigData or Get the Current Values or Set New gc_SetConfigData Values of the Parameters of the Line Device Get the Parameters from the Target Data Block for the gc_GetConfigData Function The following describes the procedure for getting or setting the configuration of a Line Device gc_util_next_parm 1 Open the line device by calling the ge_OpenEx function and get the line device ID 2 If the parameters of the line device are protocol CDP parameters use an approach similar to getting the CDP parameter ID described in the Getting or Setting Protocol Configuration in Synchronous Mode section 3 Create the target object data a GC_PARM_BLK data structure with the appropriate set ID parm ID value size and value if applicable by calling the Global Call utility functions See the Globa
71. ated The functions that can use these target types are g c_GetConfigData E1 T1 and ISDN technologies only ge_SetConfigData gc_ReqService and gc_RespService Target Object Availability Except for the GCTGT_GCLIB_SYSTEM target object all target IDs are generated or assigned by the Global Call API when the target object is created for physical targets or loaded for software targets Table 4 shows when a target object becomes available and when it becomes unavailable depending on the target type Table 4 Target Object Availability Target Type Target Object Available Target Object Unavailable GCTGT_GCLIB_SYSTEM GCTGT_CCLIB_SYSTEM t After gc_Start After gc_Stop GCTGT_GCLIB_CRN GCTGT_CCLIB_CRN After a call is created gc_MakeCall returns or GCEV_OFFERED is received After gc_ReleaseCallEx GCTGT_GCLIB_NETIF GCTGT_CCLIB_NETIF GCTGT_GCLIB_CHAN GCTGT_CCLIB_CHAN After gc_OpenEx After gc_Close t For E1 T1 and ISDN technologies only Retrieving Target IDs Before the Global Call application can retrieve update or query the configuration data of a target object it should obtain the target ID as shown in Table 5 Table 5 Obtaining Target IDs Target ID Procedure for Obtaining Target ID GCGV_LIB After the call control library has been successfully started that is after the gc_Start function is called the target
72. ation Library Information Functions Enables an application to get information about the call control libraries being used See the Global Call API Library Reference for more information about these functions Debugging Facilities Global Call provides powerful debugging capabilities for troubleshooting protocol related problems including the ability to generate a detailed log file See the appropriate Global Call Technology Guide for information on the debugging facilities available when using Global Call with each technology Global Call Architecture The Global Call development software architecture is based on the Intel Dialogic architecture that supports Host Media Processing HMP software and DM3 hardware The architecture is described in the following topics e Overview e Global Call API Overview Figure 1 shows a system level view of the Global Call architecture for IP technology and Figure 2 shows the Global Call architecture for E1 T1 and ISDN technologies on DM3 hardware Global Call API for HMP on Windows Programming Guide August 2006 19 E Product Description ntel a Figure 1 Global Call Architecture for IP Technology Media Routing Call Control H 323 or SIP Media IP Media Signaling Call Control Control Call Control IP Network Library Library IPT CCLib IPM CCLib RTP RTCP IP Media Resource Media IP Network 20 Global Call API for HMP on Windows Programmi
73. ation Flexible Routing Initializing Global Call Flexible Routing e Device Initialization Hint Flexible Routing e Using Protocols Flexible Routing Determining Channel Capabilities Flexible Routing Digital Network Interface boards support three different types of voice devices e El CAS compatible e T1 CAS compatible e ISDN compatible The E1 CAS compatible is a superset of T1 CAS compatible and the T1 CAS compatible is a superset of ISDN compatible When using Global Call only certain DM3 network interface devices can be associated with certain other DM3 voice devices using gec_OpenEx or gec_AttachResource Attaching DM3 devices together depends on the network protocol used and voice device capabilities Specifically e A DM3 ISDN network device can be attached to any DM3 voice device e A DM3 T1 CAS network device must be attached to a T1 CAS compatible DM3 voice device e A DM3 El CAS network device must be attached to an E1 CAS compatible DM3 voice device An application can query the capabilities of a device using the dx_getfeaturelist function which includes information about the front end supported meaning ISDN TI CAS or R2 MF See the Voice API Library Reference for more information about the dx_getfeaturelist function When using Global Call if a voice device is not CAS or R2 MEF capable it cannot be attached either in the ge_OpenEx function or when using the gec_AttachResource function to
74. ation data from Global Call RTCM retrieval events e Correcting errors in input configurable parameter data based on the Global Call error messages Global Call RTCM The Global Call RTCM acts as an interface between the customer application and the configurations of the target objects A target object is a configurable basic entity and is represented by its target type and target ID for more information see Section 1 5 4 Target Objects on page 25 As mentioned before the Global Call RTCM comprises the RTCM Manager and the RTCM API functions The RTCM Manager is responsible for configuring components including the Global Call Library GCLib Call Control Library CCLib protocol and firmware parameters see Section 9 3 Using RTCM Parameters on page 112 The RTCM API functions are used to get set or query configuration parameters consisting of a specified target object and the configuration data from the customer application to the software module where the target object is located The Global Call RTCM maintains the information about a target object with its associated software module so that the Global Call RTCM can call the appropriate software module to execute the configuration request The Global Call RTCM also assigns a unique ID for each request and outputs it to the application The ID is used by the application for tracking function calls When using IP technology only the ge_SetConfigData function is
75. ature that allows a device to send a request to another remote device for some kind of service Some examples of the services that may be requested are e Device Registration e Channel Setup e Call Setup e Information Requests e Operational Requests In general this feature is useful when a Global Call application needs to make a request between two Global Call devices across a network Some examples of typical uses are e Registration Requests e Administration Requests for example logon requests e Bandwidth Requests e Capabilities Requests for example determining remote side capabilities e Preference Requests for example informing remote side of setup preferences Since this feature is rather generic the capabilities in a given technology are largely dependent on the support provided by the call control libraries for that technology Refer to the appropriate Global Call Technology Guide for more information Figure 32 shows the architecture of the GCSR feature Global Call API for HMP on Windows Programming Guide August 2006 127 E Handling Service Requests ntel a Figure 32 Service Request Architecture CUSTOMER APPLICATION Operation and Configuration Subsystem GlobalCall Operation and Configuration Subsystem CALL CONTROL LIBRARY Network Interface Remote Device 10 2 Service Request Components Using the Global Call Service Request GCSR feature involves the following API components gc_ReqServi
76. bilities provided by Global Call Topics include the following Eror Handling OVerviW sacerravsun arrett EE RIERO EIERE EA EEE 85 Error Handling Overview When an error occurs during execution of a function one of the following occurs e The function returns with a value lt 0 e The unsolicited error event GCEV_TASKFAIL is sent to the application Call control libraries supported by the Global Call API may have a larger set of error codes than those defined in the gcerr h header file The call control library error values are available using the gce_ErrorInfo function which retrieves Global Call and call control library information To retrieve the information this function must be called immediately after the Global Call function failed This function returns a result value associated directly with the Global Call and call control library The gc_ResultInfo function retrieves information about solicited and unsolicited events when a Global Call application gets an expected or unexpected event To retrieve the information the gc_ResultInfo function must be called immediately after a Global Call event arrives and before the next event returns Global Call and call control library information related to the last Global Call function call To process an error this function must be called immediately after an event is returned to the application For example if an alarm occurs while making an outbound call a GCEV_DISCONNECTED ev
77. butes Alarm source objects are registered automatically when the ge_Start function is called e Default alarm source object data provided by GCAMS Alarm Numbers and Names Alarm events are identified in the database by name and number The following functions are used to retrieve the names numbers and IDs and to convert them from one to the other gc_AlarmName converts the alarm name to its text name for a given event Alarm names are assigned by the developer for use in report generation gc_AlarmNumber retrieves the alarm number for a given event Alarm numbers values are predefined for a given ASO See the Global Call API Library Reference for ASOs that are common to multiple call control libraries gc_AlarmNumberToName converts the alarm number to its text name Alarm Source Object IDs and Names Alarm source objects ASOs are identified in the GCAMS database by the ASO ID and by the ASO name ASOs that are not part of a call control library have predefined names as provided in the Global Call API Library Reference The names of ASOs that are part of a call control library are provided in the appropriate Global Call Technology Guide Global Call API for HMP on Windows Programming Guide August 2006 8 3 8 3 1 Note Note Alarm Handling The following functions are used to retrieve ASO names and IDs and to convert them from one to the other gc_AlarmSourceObjectID retrieves the alarm sourc
78. by CCITT IE See Information Element Information Element IE Used by the ISDN Integrated Services Digital Network protocol to transfer information Each IE transfers information in a standard format defined by CCITT standard Q 931 Integrated Services Digital Network See ISDN ISDN Integrated Services Digital Network An internationally accepted standard for voice data and signaling that provides users with integrated services using digital encoding at the user network interface Also the name of a call control library configured for Global Call LAPB Link Access Protocol Balanced LAPD Link Access Protocol on the D channel Line Device Identifier LDID A unique number that is assigned to a specific device or device group by Global Call main thread See thread multitasking functions Functions that allow the software to perform concurrent operations After being initiated multitasking functions return control to the application so that during the time it takes the function to complete the application program can perform other operations such as servicing a call on another line device multithread asynchronous see extended asynchronous network handle SRL device handle associated with a network interface board or time slot equivalent to the device handle returned from the network library s dt_open function network resource Any device or group of devices that interface with the telephone network Network resource
79. ce function to make a request gc_RespService function to respond to a request GCEV_SERVREQ an event indicating that a request has been received GCEV_SERVRESP an event indicating a response has been received therefore this is also a termination event for the ge_ReqService function GCEV_SERVRESPCMPLT termination event for the gc_RespService function When using the GCSR all requests and responses are to be made on specific device targets that is LDID CRN and depending on the type of request and the call control library used additional restrictions may apply See the appropriate Global Call Technology Guide for more information 128 Global Call API for HMP on Windows Programming Guide August 2006 n Handling Service Requests 10 3 Service Request Data All information transmitted and received using the Service Request feature is done using the generic GC_PARM_BLK data structure Three parameter IDs under the GCSET_SERVREQ set ID are used for all requests and responses PARM_SERVICEID unsigned long the service identification number This is a number assigned by the call control library to distinguish between requests and is used as follows e When making a request gc_ReqService ignore this field e When generating a response gc_RespService this value needs to be set to the same ID as the ID of the received request through GCEV_SERVREQ e When receiving a response through GCEV_SERVRESP
80. ce If an event bit in the mask is cleared the event is disabled and not sent to the application The unsolicited events listed in Table 9 require a signal handler if they are enabled Unsolicited events that cannot be masked must use a signal handler All technology specific unsolicited events also require a signal handler see the appropriate Global Call Technology Guide for details If any of these unsolicited events are not masked by the application and signal handlers are not defined they are queued without being retrievable and memory problems are likely to occur Table 9 Unsolicited Events Requiring Signal Handlers 3 5 3 5 1 64 Note Event Default Setting Maskable GCEV_ALERTING enabled yes GCEV_PROCEEDING disabled yes GCEV_DETECTED disabled yes GCEV_BLOCKED enabled yes GCEV_UNBLOCKED enabled yes GCEV_DISCONNECTED enabled no GCEV_TASKFAIL enabled no Advanced Call Control with Call Hold and Transfer The advanced call model applies only to E1 T1 and ISDN technologies It does not apply to IP technology which uses a different scheme for features such as call transfer See the Global Call IP Technology Guide for more information This section describes the advanced call state model Topics include e Advanced Call State Model Overview e Advanced Call States for Hold and Transfer e Call Hold e Call Transfer Advanced Call State Model Overview The advanced call model provides addit
81. ce channels in a single thread This streamlined code reduces the system overhead required for inter process communication and simplifies the coordination of events from many devices In Windows environments when calling the gc_GetMetaEventEx function from multiple threads ensure that your application uses unique thread related METAEVENT data structures or ensure that the METAEVENT data structure is not written to simultaneously 5 2 Tips for Programming Drop and Insert Applications Note This section applies to E1 T1 and ISDN technologies only To the Global Call application signaling is made available to the application as follows Signaling information is passed to the Global Call application in the form of call control events for example line answer is passed as a GCEV_ANSWERED event Signaling such as line busy is available to the application as an EGC_BUSY error code or a GCRV_BUSY result value line no answer is available as an EGC_NOANSWER error code or GCRV_NOANSWER result value Signaling such as a protocol error an alerting event a fast busy an undefined telephone number or network congestion are all returned to the application as an EGC_BUSY error code or aGCRV_BUSY result value Protocols without acknowledgement for example non backward CAS signaling protocols generate a GCEV_DISCONNECTED event with an EGC_BUSY error code or a GCRV_BUSY result value when timeout or protocol errors occur during dialing For a
82. cess to know when a task is complete or when an external event occurs extended asynchronous In Windows environments the extended asynchronous multithread asynchronous model extends the features of the asynchronous model with the extended functions sr_WaitEvtEx and gc_GetMetaEventEx These extended functions allow an application to run different threads wherein each thread handles the events from a different device failed library A call control library configured to be recognized by the Global Call API and which did not successfully start when the Global Call gc_Start function was issued Global Call API for HMP on Windows Programming Guide August 2006 145 intel glare When an inbound call arrives while an outbound call is in the process of being setup a glare condition occurs Unless the protocol specifies otherwise the incoming call takes precedence over the outbound call Global Call A unified high level API that shields developers from the low level signaling protocol details that differ in countries around the world Allows the same application to easily work on multiple signaling systems worldwide for example ISDN T1 robbed bit R2 MF pulsed SS7 IP H 323 etc Digital Network Interface boards Network interface boards that provide E1 and T1 interfaces These boards provide the physical interfaces for HMP software applications that require network connectivity IA5 International Alphabet No 5 defined
83. d in the following sections e Basic Call States at the Inbound Interface e Basic Call States at the Outbound Interface e Basic Call States for Call Termination Global Call API for HMP on Windows Programming Guide August 2006 33 Call State Models i ntel 3 2 1 34 Basic Call States at the Inbound Interface The basic inbound call states are as follows Null state GCST_NULL This state indicates that no call is assigned to the channel time slot or line This is the initial state of a channel when it is first opened This state is also reached when a call is released or after the channel is reset A channel in this state is available for inbound calls after being initialized to receive incoming calls Call Detected GCST_DETECTED An incoming call has been received but not yet offered to the application In this state the call is being processed which typically involves waiting for more information or allocating a resource Although the call is not yet offered to the application this state is for informational purposes to reduce glare conditions since the application is aware of the presence of a call on the channel Call Offered GCST_OFFERED This state exists for an incoming call when the user application has received a call establishment request but has not yet responded The newly arrived inbound call is offered to the user application to be accepted answered rejected etc Call information is typically available a
84. d to the application regardless of the amount of information available The application can then request and collect more information as required If the technology call control layer is configured to send the call acknowledgement then the call is offered to the application based on the minimum amount of information specified Minimum Information Specified If the incoming call does not have sufficient information the call is offered to the application based on the amount of information required If the technology is configured to accept minimum information the call is offered to the application only after the specified minimum amount of information is received Thereafter the application can request and collect more information as required If the technology is not configured to accept minimum information Global Call API for HMP on Windows Programming Guide August 2006 In tel Call State Models then the call is offered to the application regardless of the amount of information available The application can then request and collect more information as required The following sections describe various configurations operating in overlap receiving mode Scenario 1 In this scenario the application is configured to acknowledge the incoming call and send a call proceeding indication after sufficient information has been received When an incoming call is detected the call is immediately offered to the application regardless of the a
85. diately to obtain the last error and additional message describing the parameter and the error pointer to the additional message field During the gc_SetConfigData function call once an error occurs Global Call stops updating the remaining parameters and returns an error value to the application If this function call requires updating multiple parameters in a target object the parameters before the error may have been updated while other parameters will not have a chance to be updated Global Call API for HMP on Windows Programming Guide August 2006 115 Lal Real Time Configuration Management ntel Note 9 4 2 2 9 4 2 3 116 gc_SetConfigData all technologies Asynchronous Mode The Global Call application receives the GCEV_SETCONFIGDATA event if all the requested parameters in a given target object are successfully updated Otherwise the Global Call application receives the GCEV_SETCONFIGDATA_FAIL event which indicates that at least one requested parameter in the target object failed to update due to an error The METAEVENT data structure which is associated with both events has a field evtdatap that points toa GC_RTCM_EVTDATA data structure The GC_RTCM_EVTDATA data structure provides the error value and additional message describing the parameter and the error When using E1 T1 and ISDN technologies the ge_SetConfigData function cannot be called in asynchronous mode for the following target types GCTGT_GC
86. e exchange of call control messages between the telephone network and virtually any network enabled application Global Call software enables developers to create applications that can work with signaling systems worldwide regardless of the network to which the applications are connected The Global Call software is ideal for high density network enabled solutions such as voice data and video applications where the supported hardware and signaling technology can vary widely from country to country As an example the signal acknowledgement or information flow required to establish a call may vary from country to country Rather than requiring the application to handle low level details Global Call software offers a consistent high level interface to the user and handles each country s unique protocol requirements transparently to the application The Global Call software comprises three major components Global Call Application Programming Interface APT A common extensible API providing network interfaces to higher levels of software Application developers use API function calls in their computer telephony applications The Global Call API is the preferred call control interface Call Control Libraries A set of libraries that provide the interface between the Global Call API and the various network signaling protocols Global Call Protocols Network signaling protocols such as T1 Robbed Bit E1 CAS ISDN QSIG IP H 323 and SIP can b
87. e invoked by the Global Call API to facilitate call control Global Call API for HMP on Windows Programming Guide August 2006 17 E Product Description ntel 3 1 2 1 2 1 1 2 2 Global Call Feature Categories The Global Call development software provides many features allowing for the development of flexible and robust applications The features fall into one of two main categories e Call Control Features e Operation Administration and Maintenance Features Call Control Features The Global Call development software provides the following call control features Basic Call Control Includes basic call control features such as the ability to make a call detect a call answer a call release a call etc The implementation of these capabilities is based on the basic call state model which is a common model for all network technologies See Section 3 2 Basic Call Model for more information on the basic call model Advanced Call Model Defines the behavior for advanced features such as hold and transfer These capabilities are provided to support technologies and protocols that support such features for example Supervised Transfer The implementation of these capabilities is based on a more advanced call state model See Section 3 5 Advanced Call Control with Call Hold and Transfer for more information The advanced call model applies only to E1 T1 and ISDN technologies not IP technology which uses a differen
88. e object ID for a given event gc_AlarmSourceObjectIDToName converts an alarm source object ID gc_AlarmSourceObjectName retrieves the alarm source object name for a given event gc_AlarmSourceObjectNameToID converts the alarm source object name to the alarm source object ID GCAMS uses predefined IDs for the ASOs it has implemented however it is recommended that applications use the ge_AlarmSourceObjectNameToID function to associate the ASO name with an ID rather than using the ID directly This allows for more flexible applications if ASOs that reside in call control libraries and have dynamically assigned IDs are added to the application In addition the following functions are used to obtain additional information about the ASOs gc_GetAlarmSourceObjectList gets all ASOs associated with a line device gc_GetAlarmSourceObjectNetworkID gets the network ID associated with a line device For more information on these functions see the individual function descriptions in the Global Call API Library Reference Sample Alarm Scenarios The following scenarios illustrate the relationship between the application GCAMS and the AOS and provide examples of alarm system configurations and the sequence for transmission of alarms The scenarios include e Scenario 1 Application Notified of First and Last Blocking Alarm e Scenario 2 Default Behavior for Alarm Notification e Scenario 3 Alarm Transmission E1 T1 and ISD
89. e process space and database resources The extended asynchronous model can be used when an application needs to wait for events from more than one group of devices and requires a state machine Because the extended asynchronous model uses only a few threads for all Intel Dialogic devices it requires a lower level of system resources than the synchronous model This model also enables using only a few threads to run the entire Intel Dialogic portion of the application Global Call API for HMP on Windows Programming Guide August 2006 31 a Programming Models l ntel A 32 Note Caution Whereas default asynchronous programming uses the sr_waitevt function to wait for events specific to one device extended asynchronous programming uses the sr_waitevtEx function to wait for events specific to a number of devices channels Do not use the sr_waitevtEx function in combination with either the sr_waitevt function or event handlers This model can run an entire application using only a few threads When an event is available the gc_GetMetaEventEx function must be used to retrieve event specific information The values returned are valid until the sr_waitevtEx function is called again Event commands can be executed from the main thread through switch statements the events are processed immediately The extended asynchronous model calls the sr_waitevtEx function for a group of devices channels and polls for waits
90. el Debugging 13 This chapter provides references to other documents that provide detailed information for debugging applications that use Global Call For general Global Call debugging information see the Runtime Trace Facility RTF Reference chapter in the Intel Dialogic System Software Diagnostics Guide For debugging information that is technology or protocol specific see the following e Global Call El T1 CAS R2 Technology Guide e Global Call ISDN Technology Guide e Global Call IP Technology Guide Global Call API for HMP on Windows Programming Guide August 2006 141 Debugging ntel A 142 Global Call API for HMP on Windows Programming Guide August 2006 intel Glossary ASO Alarm Source Object The source of an alarm for example either a physical alarm or a logical alarm ANl on Demand A feature of AT amp T ISDN service whereby the user can automatically request caller ID from the network even when caller ID does not exist ANI Automatic Number Identification A service that identifies the phone number of the calling party ASCII American Standard Code for Information Interchange asynchronous function A function that returns immediately to the application and returns a completion termination at some future time An asynchronous function allows the current thread to continue processing while the function is running asynchronous mode Classification for functions that operate without blocking other functio
91. ent is sent to the application with a result value indicating an alarm on the line The GCEV_BLOCKED event is also generated with a result value that also indicates an alarm on the line See the appropriate Global Call Technology Guide for information on specific protocol errors If an error occurs during execution of an asynchronous function a termination event such as the GCEV_GETCONFIGDATA_FAIL E1 T1 and ISDN technologies only or GCEV_SETCONFIGDATA_ FAIL all technologies event is sent to the application No change of state is triggered by this event If events on the line require a state change this state change occurs as described in Section 3 4 3 Call Termination in Asynchronous Mode on page 60 When an error occurs during a protocol operation the error event is placed in the event queue with the error value that identifies the error Upon receiving a GCEV_TASKFAIL event the application can retrieve the reason for the failure using the gc_ResultInfo function An unsolicited GCEV_ERROR event can be received if an internal component fails The gc_ResultInfo function can be used to determine the reason for the event Valid reasons are any of the Global Call reasons error code or result values or a call control library specific reason see the appropriate Global Call Technology Guide Global Call API for HMP on Windows Programming Guide August 2006 85 Error Handling 86 Global Call API for HMP on Windows Programmi
92. ephony environment a normally continuous and individual communication for example someone speaking on a telephone is 1 digitized 2 broken up into pieces consisting of a fixed number of bits 3 combined with pieces of other individual communications in a regularly repeating timed sequence multiplexed and 4 transmitted serially over a single telephone line The process happens at such a fast rate that once the pieces are sorted out and put back together again at the receiving end the speech is normal and continuous Each individual pieced together communication is called a time slot tone resource Same as a voice resource except that a tone resource cannot perform voice store and forward functions transmit Sending or broadcasting of digitized information by a device Two B Channel Transfer TBCT Connects two independent B Channel calls at an ISDN PRI user s interface to each other at the PBX or CO The ISDN PRI user sends a Facility message to the PBX or CO requesting that the two B Channel calls be connected If accepted the user is released from the calls unsolicited event An event that occurs without prompting for example GCEV_BLOCKED GCEV_UNBLOCKED etc USID User Service Identifier unblocked The condition of a line device such that an application can perform any valid function on the line device for example wait for a call or make a call By default when a line device is first opened it is in the blocked
93. er data by calling the gc_util_get_next_parm function If an error occurs call the gc_ErrorInfo function to find the error and correct it 9 7 2 Getting or Setting CCLib Configuration in Synchronous Mode Note This section applies to E1 T1 and ISDN technologies only The Global Call RTCM feature allows the customer application to retrieve or change the default configuration of a CCLib even before any line device is opened Figure 28 shows the procedure for synchronous mode Figure 28 Getting or Setting CCLib Configuration in Synchronous Mode Bais GlobalCall Application Library gc_Start Load CCLib gc_CCLibNameToID Get CCLib ID Create Target Data for Retrieving ge_util_insert_parm_ref or or Upddating CCLib Parameters gc_util_insert_parm_vall gc_GetConfigData or Get the Current Values or Set New gc_SetConfigData Values of the CCLib Parameters gc_util_next_parm Get the Parameters from the Target Data Block for the gc_GetConfigData Function The following describes the procedure for getting or setting the configuration of a CCLib in synchronous mode 1 Load the call control library after the ge_Start function is called 2 Find the CCLib ID using its name by calling the ge_ CCLibNameToID function If the application has doubt about the CCLib name it can call the ge_GetCCLibStatusAll function to verify whether the CCLib has been started 3 Create the target object data a GC_
94. er that is supported by IP technology only For more specific information about implementing call transfer on IP technology see the Global Call IP for Host Media Processing Technology Guide For more specific information about implementing call transfer on E1 T1 and ISDN technologies see Section 3 5 Advanced Call Control with Call Hold and Transfer on page 64 and the appropriate Global Call Technology Guide The topics discussed in this chapter are JInroduchon to Cal TANTE nn yes dee ea ersa dee an denn noha ed opens be ea need 131 e Call Transfert State Machine 2264444444256 54856 404504405044 50 hiired iiia 132 11 1 Introduction to Call Transfer Global Call supports the following call transfer methods e Blind Call Transfer e Supervised Call Transfer 11 1 1 Blind Call Transfer In a blind call transfer scenario party A transfers the call between A and B Call 1 to a call between party B and C without consulting party C Party A places the primary call Call 1 on hold directly dials the Party C address and then disconnects from Call 1 before the second call Transferred To Call Call 2 between B and C is established Party A may also request party B to dial Party C s address and then disconnect from Call 1 after Call 2 between B and C has been established Before call transfer can occur party A must be in a call with party B Primary Call Call 1 Note In the scenario shown in Figure 34 party B initiates the transfe
95. es 78 Global Call API for HMP on Windows Programming Guide August 2006 5 3 5 3 1 Application Development Guidelines connected so as to provide the calling party with immediate outbound line status and voice cut through For a drop and insert application in which a call cannot be completed the application can simulate and return a busy tone or a fast busy redial tone to the calling party Typically this condition occurs when a GCEV_DISCONNECTED event is generated due to a timeout or a protocol error during dialing or due to R2 backward signaling indicating a busy called party s line equipment failure network congestion or an invalid telephone number When a call cannot be completed because the called party s line is busy 1 Use a tone or voice resource to generate a busy tone 60 ipm impulses per minute or to record a busy tone 2 Connect the busy tone to the calling party s line or play back the recorded busy tone file 3 Drop and release the calling party s line when a GCEV_DISCONNECTED event is received When a call cannot be completed because of equipment failure network congestion or an invalid telephone number 1 Use a tone or voice resource to generate a fast busy tone 120 ipm or to record a fast busy tone 2 Connect the fast busy tone to the calling party s line or play back the recorded fast busy tone file 3 Drop and release the calling party s line when a GCEV_DISCONNECTED event i
96. est additional information if required See Section 3 4 1 8 Overlap Receiving for more information A call proceeding indication can be sent by the technology call control layer or by the application by issuing the ge_CallAck GCACK_SERVICE_PROC function Otherwise the application can accept or answer the call by issuing the gec_AcceptCall or ge_AnswerCall functions respectively When developing applications if the GCEV_DETECTED event is not supported a GCEV_DISCONNECTED event is only received if the host application already received the GCEV_OFFERED event before the remote side disconnects Global Call API for HMP on Windows Programming Guide August 2006 43 Call State Models i ntel 3 4 1 5 3 4 1 6 3 4 1 7 3 4 1 8 44 Note Call Routing After the call has been offered a call proceeding indication can be sent to the remote party to indicate that all the information has been received and the call is now proceeding This indication can be sent by the technology call control layer or by the application by issuing the gce_CallAck GCACK_SERVICE_PROC function This stage typically involves routing the call to the destination exchange or party An information call routing tone can be played at this point to inform the remote party that the call is routing Call Acceptance If the application or thread is not ready to answer the call a ge_AcceptCall function is issued to indicate to the remote end that
97. fined in the CONFIG file CCPARM_CA_PVD_QTEMP PVD Qualification Template Specifies which PVD template to use Possible values are e PAMD_QUALITMP First predefined qualification template This is the default value e No qualification template Setting CCPARM_CA_PVD_QTEMP to a value of PAMD_QUAL2TMP is not supported The CCPARM_CA_PVD_QTEMP parameter can also be set to a qualification template ID that is defined in the CONFIG file By default qualification template parameters are set to the most common values However it is possible to tune these parameters in the CONFIG file as described in Technical Note 030 available on the Customer Support web site at http resource intel com telecom support tnotes tnbyos 2000 tn030 htm The technical note is not written specifically for HMP but the same principle applies DM IP boards use a slightly different version of the PVD PAMD qualification templates the values are adjusted for gain loss CONFIG files for DM IP boards do include PVD PAMD qualification templates Configuring Call Progress Analysis on a Per Channel Basis Global Call also supports the setting of call progress analysis parameters on a per channel basis When call progress analysis parameters are set on a per channel basis the parameter settings apply to all calls made on that channel line device To specify call progress analysis behavior on a per channel basis use the ge_SetConfigData function The relevant func
98. for events specific to that group of devices In this model the SRL event handler thread is not created the SR_MODELTYPE value is set to SR_STASYNC and the sr_enbhdlr function in not used In the extended asynchronous model functions are initiated asynchronously from different threads A thread waits for events using the sr_waitevtEx function The event information can be retrieved using the gc_GetMetaEventEx function When this function returns the event information is stored in the METAEVENT data structure When calling the ge_GetMetaEventEx function from multiple threads ensure that your application uses unique thread related METAEVENT data structures thread local variables or local variables or ensure that the METAEVENT data structure is not overwritten until all processing of the current event has completed The event information retrieved determines the exact event that occurred and is valid until the sr_waitevtEx function returns with another event Global Call API for HMP on Windows Programming Guide August 2006 intel Call State Models 3 This chapter describes the call state models provided by Global Call Topics include the following Cal Sae Model OVV scccassopenaedde ince bated cacda E aE 33 Pase Call Model isoro chaos ce eee Cenk edra EEEE R 3a e Basic Call Model Configuration Options 0 0 00 e eee eee eee 36 Basic Call Control in Asynchronous Mode 224 50ccs0eeceseuresseaas
99. for HMP on Windows Programming Guide August 2006 ntel Alarm Handling 8 3 2 Scenario 2 Default Behavior for Alarm Notification The default behavior is that the application is not notified of alarm events See Figure 23 Figure 23 Default Behavior for Alarm Notification Application gc_OpenEx GCEV_BLOCKED Alarm Source Object ASO GlobalCall First Blocking Alarm Occurred Second Blocking Alarm Occurred First Unblocking Alarm Occurred Second Unblocking Alarm Occurred GCEV_UNBLOCKED Global Call API for HMP on Windows Programming Guide August 2006 107 Alarm Handling 8 3 3 Scenario 3 Alarm Transmission Note This scenario applies to E1 T1 and ISDN technologies only Figure 24 shows a scenario that demonstrates the sequence of function calls and the actions that they cause in the transmission of alarms Figure 24 Alarm Transmission Application gc_OpenEx gc_SetAlarmParm optional depending on ASO gc_TransmitAlarms gc_StopTransmitAlarms gc_SetAlarmParm optional depending on ASO 108 Alarm Source Object ASO GlobalCall Set Alarm Parameters Transmit Alarm s Transmit Alarm s Stop Transmitting Alarms Stop Transmitting Alarms Set Alarm Parameters Global Call API for HMP on Windows Programming Guide August 2006 intel Real Time Configuration 9 Management This chapter describes the Global
100. for more information When the application returns a GCEV_ALARM event indicating that an alarm has been received information about the alarm can be retrieved using the gc_AlarmName function The gc_AlarmName function converts the alarm to its text name to allow for interpretation of the reason for the alarm For more information on retrieving alarm data for a given ALARM_EVENT see Section 8 2 5 Retrieving Alarm Data on page 104 Some of the ways the information provided by the GCEV_ALARM events can be used are e Administration of alarms using alarm information to determine the appropriate configuration of GCAMS e Detection and transmission of alarm conditions between networks drop and insert applications e Manual handling of alarms for drop and insert applications e Generating reports e Troubleshooting connections and protocols Configuration of Alarm Properties and Characteristics GCAMS provides the ability to set the alarm configuration for line devices and alarm source objects The initialization of ASO configuration values is done at build time The Global Call API provides several functions that are used to configure how when and which alarms are sent to the application and to define the characteristics of the alarms These functions are e gc SetAlarmConfiguration e gc SetAlarmFlow e gc SetAlarmNotifyAll e gc SetAlarmParm Corresponding functions allow for the retrieval of the current sta
101. h he alee owt Pe 97 8 1 Alarm Handling Overview 1 0 0 0 000 cc teas 97 8 1 1 Alarm Management System Components 0000 0c eee eee 97 8 2 Operation and Configuration of GCAMS 0 00 ee 99 4 Global Call API for HMP on Windows Programming Guide August 2006 10 11 12 tel Contents 8 2 1 Generation of Events for Blocking Alarms 00000 ccc eee eee eae 99 8 2 2 Generation of Alarm Events 0 000 cece 100 8 2 3 Configuration of Alarm Properties and Characteristics 101 8 2 4 Starting and Stopping Alarm Transmission 0000 eee eee 104 8 2 5 Retrieving Alarm Data ees raees a O eee 104 8 3 Sample Alarm ScenariOS 0 000 eee 105 8 3 1 Scenario 1 Application Notified of First and Last Blocking Alarm 105 8 3 2 Scenario 2 Default Behavior for Alarm Notification 00 107 8 3 3 Scenario 3 Alarm Transmission 00000 cece eee ee 108 Real Time Configuration Management 0 0000 cece 109 9 1 Real Time Configuration Manager Overview 00 sasaaa aeaea 109 9 2 RIGM Componentsi 2 saa ede eke tae a eee ene ie Vg Dan dowd E R 110 9 2 1 Customer Application Using Global Call RTCM 0 0000 e eee 111 9 2 2 Global Call RICM 4 sae oeeh eres ieee geet eel wae ettheods Reale os 111 9 2 3 RTCM Parameters e aea A a e A P E tees 112 9 3 Using RTCM Parameters 0 sanr
102. hen using the gc_RespService function PARM_SERVICEID is a mandatory parameter of the GC_PARM_BLK pointed to by the datap function parameter 10 4 General Service Request Scenario Figure 33 is a general scenario of how the Service Request feature operates in asynchronous mode Since the Service Request feature is generic the nature of each request and response depends on the underlying call control library Refer to the appropriate Global Call Technology Guide for more information Global Call API for HMP on Windows Programming Guide August 2006 129 Handling Service Requests n Figure 33 Generic Service Request Operation Requesting Application Requesting Responding Responding Device Device Application gc_ReqService Generate Request Notification of Request GCEV_SERVICEREQ Process Request gc_RespService Generate Response Notification of Response GCEV_SERVICERESP Note Indicates that the extdatap of each of these events contains a pointer to GC_PARM_BLK which in turn contains all the information associated with the corresponding request or response The pointer is only valid until the next call to gc_GetMetaEvent or gc_GetMetaEventEx 130 Global Call API for HMP on Windows Programming Guide August 2006 intel Using Global Call to Implement 11 Call Transfer The information in this chapter is technology independent however it describes a method of call transf
103. ical application of the gc_SetUserInfo and gec_GetUserInfo functions is on an ISDN platform where it is desired to transmit and receive user to user information elements in each incoming and outgoing message In the case of ge_SetUserInfo user information is transmitted to the remote side embedded in a protocol specific message The duration flag is used to specify the persistence of the information Using the duration flag the user information may be specified to persist as long as the current or next call or for all calls including the current call When the duration is specified to be all calls on the specified line device the user information is valid and utilized for all calls until the device is eventually closed via ge_Close In the case of ge_GetUserInfo the user information is retrieved from an already received protocol specific message that has been received from the remote side Note that the user information parameters returned from the call control library in the GC_PARM_BLK buffer must be processed or copied prior to the next Global Call function call The reason for this is that the GC_PARM_BLK buffer will be deallocated within Global Call in a subsequent function call Global Call API for HMP on Windows Programming Guide August 2006 95 Call Control 96 Global Call API for HMP on Windows Programming Guide August 2006 intel Alarm Handling 8 8 1 8 1 1 This chapter describes the Global Call
104. ide August 2006 a l ntel About This Publication Global Call IP Technology Guide Standard Runtime Library API Programming Guide Standard Runtime Library API Library Reference e The Release Update for your HMP software which may include updates to this manual available on the Telecom Support Resources website at http www intel com design network products telecom software index htm http developer intel com design telecom support for technical support http www intel com design network products telecom for product information Global Call API for HMP on Windows Programming Guide August 2006 15 a About This Publication l ntel b 16 Global Call API for HMP on Windows Programming Guide August 2006 intel Product Description 1 1 1 This chapter describes the Global Call software Topics include Global Call Sottware OVEIMEW eere r araia a iiaa E EEE ERER 17 Gioball Call Fedme Cate dories seeder sr cekeu ir kE EIRENE EEE RE EE 18 Global Call Architect eser tarer tiaren enie aa En A E Ea 19 CC Omi LIDE 4 i406 gas an I EEEE RE ERE EEEN 22 Global Call Object Iden oc ive bis eee eee wesw inan 23 Global Call Software Overview Global Call development software provides a common signaling interface for network enabled applications regardless of the signaling protocol needed to connect to the local telephone network The signaling interface provided by Global Call software facilitates th
105. ide has indicated to the calling party that the destination user is alerting or ringing but has not yet answered Call Connected GCST_CONNECTED This is a common state that exists for an incoming call when the user has answered the call Global Call API for HMP on Windows Programming Guide August 2006 In 3 2 2 3 2 3 Call State Models Basic Call States at the Outbound Interface The basic outbound call states are as follows Null state GCST_NULL This state indicates that no call is assigned to the channel time slot or line This is the initial state of a channel when it is first opened This state is also reached when a call is released or after the channel is reset The channel in this state is available for making outbound calls Call Dialing GCST_DIALING This state exists for an outgoing call when an outbound call request is made The call signaling or message is in the process of being prepared for transfer or being transferred across the telephony network In response the remote side may request more information acknowledge the call accept the call or answer the call Send More Information GCST_SENDMOREINFO This state exists for an outgoing call when the user has received an acknowledgement of the call establishment request that permits or requests the user to send additional call information to the network in overlap mode The information typically digits is in the process of being prepared for transfer or bei
106. ied as the first two arguments to the Global Call RTCM API function An example of a target object is GCTGT_CCLIB_CHAN Global Call line device ID Set ID and parameter ID This uniquely represents a parameter within a specified target object See Section 9 4 Getting and Setting Parameter Information on page 114 for more information A set ID typically represents a group of parameters that are closely related and are maintained in the same software module The parm ID represents a parameter within a given set ID In general Global Call API for HMP on Windows Programming Guide August 2006 9 3 1 9 3 2 Real Time Configuration Management parameter IDs are only guaranteed to be unique within a given set ID Note that some configurable parameters are defined only for a specific software module while others may be used across different software modules Typically a software module that supports RTCM contains multiple parameter sets as well as target objects Note The set ID and parm ID pairs are used by other Global Call features in addition to RTCM Parameter Dependencies A high level target object such as a system entity can contain a lower level target object such as a channel entity When a target object is created its configuration is initialized as the default or current value depending on its implementation If a parameter is defined and used for both the high level and the lower level target object updating the p
107. ignaling Signaling protocols in which the signaling bits for each time slot are in a fixed location with respect to the framing In E1 systems time slot 16 is dedicated to signaling for all 30 voice channels time slots The time slot the signaling corresponds to is determined by the frame number within the multiframe and whether it s the high or low nibble of time slot 16 In T1 systems the signaling is also referred to as robbed bit signaling where the least significant bit of each time slot is used for the signaling bits during specific frames CEPT Conference des Administrations Europeenes des Postes et Telecommunications A collection of groups that set European telecommunications standards compelled signaling Transmission of next signal is held until acknowledgement of the receipt of the previous signal is received at the transmitting end configured library A call control library supported by the Global Call API congestion Flow of user to user data CDP Country Dependent Parameter see the Global Call Country Dependent CDP Reference for details CRN See Call Reference Number CRV Call Reference Value D channel The data channel in an ISDN interface that carries control signals and customer call data in packets This information is used to control transmission of data on associated B channels data structure Programming term for a data element consisting of fields where each field may have a different definition and leng
108. ih Party A Party B Party A Party B Party A Party B ikon gt E Call 1 I Call 1 IE Call 2 Call 2 Call 3 Call 3 E E Transferred_ Transferred_ Transferred_ Transferred_ To_Party C To_Party C To_Party C To_Party C Before Transfer Call 2 Setup Call 3 Setup After Call Transfer 11 2 Call Transfer State Machine Table 14 lists the new Global Call call states for blind call transfer 132 Global Call API for HMP on Windows Programming Guide August 2006 Using Global Call to Implement Call Transfer Table 14 New Global Call Transfer Call States New Call State Description Trigger Event GCST_INVOKE_XFER_ ACCEPTED The transfer request has been accepted by the remote party GCEV_INVOKE_XFER_ACCEPTED unsolicited event GCST_INVOKE_XFER The invoke transfer is successful i e the transfer is completed at transferring party GCEV_INVOKE_XFER termination event for the gc_InvokeXfer function GCST_REQ_XFER Receive a transfer request and wait for accept reject GCEV_ REQ_XFER unsolicited event GCST_ACCEPT_XFER Accepted the transfer request GCEV_ACCEPT_XFER termination event for the gc_AcceptXfer function GCST_XFER_CMPLT Transfer is completed at transferred party GCEV_XFER_CMPLT unsolicited event GCST_REQ_INIT_XFER Receive a transfer initiate request and wait for accept reject GCEV_ REQ_INIT_XFER unsolicited event
109. iled error message is returned T1 A digital line transmitting at 1 544 Mbps over 2 pairs of twisted wires Designed to handle a minimum of 24 voice conversations or channels each conversation digitized at 64 Kbps T1 is a digital transmission standard in North America T1 robbed bit A T1 digital line using robbed bit signaling In T1 robbed bit signaling systems typically the least significant bit in every sixth frame of each of the 24 time slots is used for carrying dialing and control information The signaling combinations are typically limited to ringing hang up wink and pulse digit dialing TBCT See Two B Channel Transfer TEI Terminal Endpoint Identifier see Recommendations Q 920 and Q 921 termination condition An event that causes a process to stop termination events Global Call events returned to the application to terminate function calls thread Windows The executable instructions stored in the address space of a process that the operating system actually executes All processes have at least one thread but no thread belongs to more than one process A multithreaded process has more than one thread that are executed seemingly simultaneously When the last thread finishes its task then the process terminates The main thread is also referred to as a primary thread both main and primary thread refer to the first thread started in a process A thread of execution is just a synonym for thread time slot In a digital tel
110. ional call control functionality over the basic call model adding the ability to transfer calls place calls on hold and retrieve calls on hold This section provides brief descriptions of the API functions used to hold retrieve and transfer calls and Global Call API for HMP on Windows Programming Guide August 2006 3 5 2 3 5 3 Note Call State Models describes the call state transitions that occur when the functions are used This section also provides figures that illustrate the call state transitions for advanced call model functions The hold retrieve and transfer functions are supported by particular protocols for the ISDN E1 PDKRT only and T1 PDKRT only technologies For more information see the function descriptions in the Global Call API Library Reference and the appropriate Global Call Technology Guide Advanced Call States for Hold and Transfer Two advanced call states are appended to the basic call model to support call hold and transfer These advanced call states are as follows On Hold State GCST_ONHOLD A call must be in the Connected call state to be put on hold When a call is put on hold the remote party is often routed via the local switch or network to receive background music while temporarily suspended from conversing with the local party The call remains on hold until the application retrieves the call effectively re transitioning it into the Connected conversational state The applicati
111. ions that use the Global Call software For additional technology specific information refer to the appropriate Global Call Technology Guide Topics included in this chapter are Commins and Lathe css co ceheeace Weed e EES AA RAN RRA ERE A 139 12 1 Compiling and Linking An application that uses the Global Call software must include references to the Global Call header files and must include the appropriate library files In addition when using specific protocols other libraries and protocol modules are dynamically loaded The Windows libraries may be linked and run using Microsoft Visual C version 6 x or later The following topics provide more information e Include Files e Required Libraries e Variables for Compiling and Linking Commands e Dynamically Loaded Libraries 12 1 1 Include Files The following header files contain equates that are required for each application that uses the Global Call library gclib h primary Global Call header file gcerr h header file containing equates for error codes Note See the appropriate Global Call Technology Guide for technology specific header files 12 1 2 Required Libraries The following library files must be linked to the application libgc lib the primary Global Call library file libdxxmt lib the primary Voice library file This library is only required if the application uses voice library functions directly for example dx_play Global Call API for HMP on Windo
112. ird party Global Call compatible call control library can be used as a custom library The Global Call library supports up to two custom libraries GC_CUSTOM2_LIB The second of two call control library place holders for custom call control libraries Any third party Global Call compatible call control library can be used as a custom library The Global Call library supports up to two custom libraries GC_DM3CC_LIB The call control library that controls access to network interfaces on Digital Network Interface boards This library is used for call control using ISDN and CAS R2MF PDK protocols signaling on Digital Network Interface boards GC_H3R_LIB The call control library that controls access to IP network interfaces This call control library supports IP H 323 and SIP protocols and is used in conjunction with GC_IPM_LIB GC_IPM_LIB The call control library that provides access to IP media resources This library is used for H323 SIP call control signaling and is used in conjunction with GC_H3R_LIB Starting Call Control Libraries Call control libraries must be started before they can be used by the Global Call functions The call control libraries are started when a ge_Start function is issued The ge_Start function allows the selective starting of call control libraries where the application can specify if all the call control libraries are to be started or only specified libraries are to be started The application can also start
113. is situation by using the asynchronous mode or multi threading technology Update Condition When using the gc_SetConfigData function to update the parameters of a target object with an active call the application can specify whether the update should occur either at the Null call state or immediately If parameters are to be updated at the Null state but the function requests to immediately update them while the target object has any active calls the function returns an error to the application If parameters are to be updated immediately the function can update them immediately or at the Null state Table 13 describes the possible settings and resulting actions for the update condition as used by the gec_SetConfigData function Global Call API for HMP on Windows Programming Guide August 2006 In Real Time Configuration Management Table 13 Update Condition Flag and Global Call Process 9 5 9 6 Update condition flag Parameter Update P P Global Call APP Allowed In Target Object 99t Object Status Global Call Action Update immediately Active or no active call Update parameter GCUPDATE_IMMEDIATE No active call Update parameter Update at Null state Active call Return error No active call Update parameter Update immediately Active call Postpone until no active call GCUPDATE_ATNULL No active call Update parameter Update at Null state Active call Postpone until no active call
114. ive voice as accurately as PAMD_FULL but is more accurate than PAMD_FULL although slightly slower in detecting an answering machine Use PAMD_ACCU when accuracy is more important than speed This is the default value CCPARM_CA_NOANSR No Answer The length of time in 10 ms units to wait after the first ringback before deciding that the call is not answered Possible values are in the range 0 to 65535 The default value is 3000 CCPARM_CA_NOSIG Continuous No Signal The maximum amount of silence in 10 ms units allowed immediately after cadence detection begins If exceeded a no ringback is returned Possible values are in the range 0 to 65535 The default value is 4000 CCPARM_CA_PAMDFAILURE PAMD Fail Time The maximum time in 10 ms units to wait for positive answering machine detection PAMD or positive voice detection PVD after a cadence break Possible values are in the range 0 to 65535 The default value is 800 90 Global Call API for HMP on Windows Programming Guide August 2006 Note Note Note 7 2 5 Call Control CCPARM_CA_PAMD_QTEMP PAMD Qualification Template Specifies which PAMD template to use Possible values are e PAMD_QUALITMP First predefined qualification template This is the default value e 1 No qualification template Setting CCPARM_CA_PAMD_QTEMP to a value of PAMD_QUAL2TMP is not supported The CCPARM_CA_PAMD_QTEMP parameter can also be set to a qualification template ID that is de
115. l Call API Library Reference for more information on the utility functions 4 Call the ge_GetConfigData or gec_SetConfigData function with target_type GCTGT_CCLIB_NETIF GCTGT_PROTOCOL_NETIF GCTGT_CCLIB_CHAN or GCTGT_PROTCOL_CHAN target_id Global Call line device ID time_out gt 0 mode EV_SYNC update condition GCUPATE_IMMEDIATE ge_SetConfigData function only 5 If the ge_GetConfigData function returns successfully obtain the individual parameter data by calling the gc_util_get_next_parm function If an error occurs call the ge_ErrorInfo function to find the error and then correct it 122 Global Call API for HMP on Windows Programming Guide August 2006 n Real Time Configuration Management 9 7 4 Setting Line Device Configuration in Asynchronous Mode Note This section applies to E1 T1 and ISDN technologies only The Global Call RTCM allows the customer application to retrieve or change the default configuration of a line device in asynchronous mode Asynchronous mode is generally suggested to be used in either of the following cases e The request is to update parameters that are call related and the channel is not at the NULL state e The target type is GCTGT_FIRMWARE_CHAN or GCTGT_FIRMWARE_NETIF that is the parameters are maintained in firmware Figure 30 shows the procedure for setting line device configuration in asynchronous mode Figure 30 Setting Line Device Configuration in Asynchron
116. l and state transitions for call control in asynchronous mode This section also describes the process for call establishment for both inbound and outbound calls and call termination in the asynchronous mode The procedures for establishing and terminating calls in the asynchronous mode are described in the following sections e Inbound Calls in Asynchronous Mode e Outbound Calls in Asynchronous Mode e Call Termination in Asynchronous Mode For E1 T1 and ISDN technologies the Advanced Call Model includes call states associated with holding retrieving and transferring calls See Section 3 5 Advanced Call Control with Call Hold and Transfer for more information In general when a function is called in asynchronous mode and an associated termination event exists the ge_Close function should not be called until the termination event has been received Otherwise the behavior is undefined Inbound Calls in Asynchronous Mode This section describes how calls are established and shows call scenarios for asynchronous inbound calls The following topics describe the processing of inbound calls in asynchronous mode e Inbound Calls in Asynchronous Mode Overview e Channel Initialization e Call Detection e Call Offered e Call Routing e Call Acceptance e Call Establishment e Overlap Receiving for E1 T1 and ISDN technologies only e Call Failure e Abandoned Calls Inbound Call Scenarios in Asynchronous Mode Inbound Cal
117. l state of a line device when it is first opened This state is also reached when a call is released or after the channel is reset by issuing the gc_ResetLineDev function If the above conditions are met the application is ready to make outbound calls Call Dialing To initiate an outbound call using the asynchronous mode the application issues a ge MakeCall function that requests an outgoing call to be made on a specific line device The ge_MakeCall function returns immediately and the call state transitions to the Dialing state The GCEV_DIALING event is generated if enabled to indicate that the call has transitioned to the Dialing state A CRN is assigned to the call being established on that line device If the gc_MakeCall function fails the line device remains in the Null state In this state dialing information is sent to the remote side Call Proceeding In the Dialing state the remote side may indicate that all the information was received and the call is proceeding In this case the GCEV_PROCEEDING event is generated and the call transitions to the Proceeding state The remote side may either accept or answer the call Call Alerting If the remote end is not ready to answer the call aGCEV_ALERTING event is generated This event indicates that the called party has accepted but not answered the call and that the network is waiting for the called party to complete the connection At this stage the remote side is typic
118. ld have to link directly with the ISDN call control library then call the required ISDN library functions cc_SetBChanState or cc_SetDChanState The gc_Extension function may be supported in either asynchronous mode synchronous mode or both depending on the call control library If the ge_Extension function is supported and called in synchronous mode the relevant information parameters returned in the GC_PARM_BLK buffer must be processed or copied prior to the next Global Call function call The reason for this is that the GC_PARM_BLK buffer will be deallocated within Global Call in a subsequent function call If the ge_Extension function is supported and called in asynchronous mode relevant information may be returned via the call control library via GCEV_EXTENSIONCMPLT termination event and its referenced extension block structure EXTENSIONEVTBLK The EXTENSIONEVTBLK structure contains technology specific information and is referenced via the extevtdatap pointer in the METAEVENT structure associated with the GCEV_EXTENSIONCMPLT event See the Global Call API Library Reference for more information about these structures 94 Global Call API for HMP on Windows Programming Guide August 2006 7 4 3 Call Control The ge_Extension function can also be used to transmit information to the remote endpoint In this case while the application at the local end point receives a GCEV_EXTENSIONCMPLT the application at the remote e
119. ling 55 null 42 55 offered 42 state diagrams asynchronous call tear down 61 states call establishment 53 supervised call transfer 67 T terminating a call asynchronous mode 61 termination events 29 tips drop and insert applications 78 general programming 77 transfer supervised 67 unsupervised 67 69 U unsolicited event synchronous mode 64 unsolicited events alarm events 99 unsupervised call transfer 69 user specified message 31 W Windows message handling 31 Global Call API for HMP on Windows Programming Guide August 2006 154 Global Call API for HMP on Windows Programming Guide August 2006
120. lled by the call control layer and call proceeding controlled by the application Figure 10 Call Acknowledgement Done by the Technology Call Control Layer and Call Proceeding Done by the Application GlobalCall Application Library Network Technology Not Enough Information Acknowledgement Incoming Call Received and Request for More Address Information More Information All Information Received GCEV_DETECTED GCEV_OFFERED gc_GetCalllnfo DESTINATION_ADDRESS gc_GetCalllnfo ORIGINATION_ADDRESS l gc_CallAck GCACK_SERVICE_PROC GCEV_CALLPROC gc_AcceptCall GCEV_ACCEPTED gc_AnswerCall GCEV_ANSWERED Note In Figure 10 the Acknowledgement and Request for More Address Information applies to E1 T1 and ISDN technologies only Call Proceeding Alerting Call Answered 3 4 2 Outbound Calls in Asynchronous Mode This section describes how calls are established and shows call scenarios for asynchronous outbound calls The following topics describe the processing of outbound calls in asynchronous mode e Outbound Calls in Asynchronous Mode Overview e Channel Initialization 52 Global Call API for HMP on Windows Programming Guide August 2006 ntel Call State Models e Call Dialing e Call Proceeding e Call Alerting e Call Connected e Overlap Sending for E1 T1 and ISDN technologies only e Call Failure e Outbound Call Scenario
121. ls in Asynchronous Mode Overview Figure 4 illustrates a Basic Inbound Call Model which shows the call states associated with establishing a call in asynchronous mode All calls start from a Null state The call establishment process for inbound calls is shown in Figure 4 See Table 6 Asynchronous Inbound Call State Transitions on page 41 for a summary of the call state transitions Global Call API for HMP on Windows Programming Guide August 2006 39 Call State Models i ntel Figure 4 Basic Asynchronous Inbound Call State Diagram gc_WaitCall called only once v NULL GCEV_DETECTED maskable e Q e nnunnnnnng DETECTED GCEV_OFFERED annunnnnnnnm GCEV_OFFERED gc_CallAck MORE_INFO GCEV_MOREINFO A 9c _CallAck CALL_PROC K aeaea GCEV_CALLPROC seesnennaensne GetMorelnfo ie Sings Seria eels haat a P CallRouting tannnnnnnnnam gc_AcceptCall CO ha A a CEV_ACCEPT ae ge_CallAck CALL_PROC GCEV_CALLPROC i gc_AcceptCall 1 1 1 1 1 1 1 1 1 gt GCEV_ACCEPT tee gc_AcceptCall gc_ReqMorelnfo GCEV_ACCEPT GCEV_MOREINFO ri v gt gc_AnswerCall RTELETTETETTTA GCEV_ANSWERED ner ACCEPTED gc_AnswerCall Pee eee EET ta GCEV_ANSWERED F Y ioe gc_AnswerCall a 4 GCEV_ANSWERED CONNECTED lt 2 22202 24502 ceseeseee see seeeeceeerenenesees Legend Required
122. ly the default configuration should be changed immediately after calling ge_Start and prior to calling ge_ OpenEx To change the default configuration for all known ASOs perform the following steps 1 Convert the ASO name to the ASO ID using the ge_AlarmSourceObjectNameToID function 2 Change the attributes of the specified ASO name using the gc_SetAlarmConfiguration function Changing the attributes of an ASO requires detailed knowledge of the given ASO The procedures for changing the configuration of line devices depends on whether all the line devices associated with the same ASO are to have the same attributes or if the application requires different behaviors for line devices associated with the same ASO For those applications that require all line devices to have the same attributes use the procedures for changing the default configuration for ASOs as described above For applications that are intended to be cross technology and or more robust the following steps should be performed to change the attributes Call ge_OpenEx 2 Retrieve the network ASO ID associated with the line device using the gc_GetAlarmSourceObjectIDToName 3 Convert the network ASO ID to a name using the gec_AlarmSourceObjectIDToName This is a necessary step as not all ASOs will have a fixed ID 4 Using the ASO name change the attributes of the line device using the gc_SetAlarmConfiguration function Note Changi
123. mount of information available to proceed with the call When the call is in the Offered state after the generation of the unsolicited GCEV_OFFERED event the application sends an acknowledgement for the incoming call by issuing a ge_CallAck GCACK_SERVICE_INFO function The application may selectively retrieve call information such as Destination address and Origination address caller ID by issuing the gc_GetCallInfo function If more information is still required the ge_ReqMoreInfo function is issued to request more information When the information is received the GCEV_MOREINFO event is generated again When all the required information is received the application may send a call proceeding indication to the remote side by issuing the ge_CallAck function Otherwise the application can choose to accept or answer the call Scenario 2 In this scenario the technology call control layer is configured to acknowledge the incoming call and send a call proceeding indication after sufficient information has been received When an incoming call is detected the technology call control layer immediately sends an acknowledgement If the minimum amount of information required is specified then the call is offered to the application only after the minimum amount of information required is received After the call is offered to the application the address information can be retrieved to determine if more information is required If more informa
124. must then call the gc_GetMetaEventt function before servicing the event In this model the SRL event handler thread must be initiated by the application by setting the SR_MODELTYPE value to SR_STASYNC For detailed information on this programming model see the Standard Runtime Library API Programming Guide Asynchronous with Win32 Synchronization Model The asynchronous with Win32 synchronization model allows an asynchronous application to receive SRL event notification through standard Windows synchronization mechanisms This model uses one thread to run all Intel Dialogic devices and thus requires a lower level of system resources than the synchronous model This model allows for greater scalability in growing systems For detailed information on this programming model see the Standard Runtime Library API Programming Guide Extended Asynchronous Programming Model The extended asynchronous programming model is basically the same as the asynchronous model except that the application uses multiple asynchronous threads each of which controls multiple devices In this model each thread has its own specific state machine for the devices that it controls Thus a single thread can look for separate events for more than one group of channels This model may be useful for example when you have one group of devices that provides fax services and another group that provides interactive voice response IVR services while both groups share the sam
125. n An application running on bi directional circuits is capable of handling two CRNs on a single line device where one call can be in an Idle state while the other call is in Active state For example a glare condition occurs when a call has been dropped but not released and an inbound call is detected as indicated in Table 10 In order to avoid a long delay in processing the inbound call the Global Call library does not wait for the outbound call to be released before notifying the application of the inbound call Table 10 Handling Glare Application Global Call Library gc_MakeCall CRN1 gt lt GCEV_DISCONNECTED CRN1 gc_DropCall CRN1 gt Global Call API for HMP on Windows Programming Guide August 2006 83 al Application Development Guidelines ntel z 84 Table 10 Handling Glare Application Global Call Library lt GCEV_OFFERED CRN2 gc_AcceptCall CRN2 gt lt GCEV_DROPCALL CRN1 gc_ReleaseCallEx CRN1 gt Alternatively the application can just respond to events using their associated CRN simply performing a gc_ReleaseCallEx upon reception of any GCEV_DROPCALL event whether the CRN is the active one or not Using this procedure the application only needs to store one CRN per line device Global Call API for HMP on Windows Programming Guide August 2006 intel Error Handling 6 6 1 The chapter describes the error handling capa
126. n if Call Progress Analysis CPA is disabled in the CONFIG file A user who does not want pre connect call progress must explicitly use the gc_SetConfigData function to disable CPA on that line device Alternatively the user can attach the voice resource after the call is connected Configuring Call Progress Analysis on a Per Call Basis To specify call progress analysis behavior use the g e_MakeCall function with an associated GC_PARM_BLK accessible via the GC_MAKECALL_BLK and GCLIB_MAKECALL BLK structures containing the CCSET_CALLANALYSIS parameter set ID and the CCPARM_CA_MODE parameter ID with one or more of the following bitmask values ORed together GC_CA_BUSY Pre connect busy tone detection GC_CA_RINGING Pre connect ringback tone detection GC_CA_SIT Pre connect special information tone SIT detection GC_CA_FAX Post connect fax detection GC_CA_PVD Post connect positive voice detection PVD GC_CA_PAMD Post connect positive answering machine detection PAMD While the CCPARM_CA_MODE bitmask offers complete flexibility in terms of the selected options not all option combinations make sense For this reason the following defines that can also be used as values to the CCPARM_CA_MODE parameter ID identify the most logical and traditionally used option combinations GC_CA_DISABLE Call progress and call analysis disabled GC_CA_PREONLY Busy and Ringing enabled Global Call API for HMP on Windows Programming G
127. nd passed to the application An overview of Global Call event categories is provided in this chapter Specific event definitions are described in the Global Call API Library Reference See the appropriate Global Call Technology Guide for technology specific event information Event Categories The events that can occur when using the Global Call API are divided into the following categories Termination Events returned after the termination of a function Termination events apply to asynchronous programming only Notification Events that are requested by the application and provide information about a function call Notification events apply to synchronous and asynchronous programming Unsolicited Events triggered by and providing more information about external events Unsolicited events apply to synchronous and asynchronous programming See the Global Call API Library Reference for detailed information about each event and the appropriate Global Call Technology Guide for any technology specific event information Global Call API for HMP on Windows Programming Guide August 2006 71 Event Handling i ntel 4 3 72 Note Note Blocked and Unblocked Event Handling Global Call uses the concept of blocked and unblocked conditions for line devices By default when the ge_OpenEx function is used to open a line device the line device is in a blocked condition meaning that the application can not perform call related func
128. nd point will receive an unsolicited GCEV_EXTENSION notification event from the network with the transmitted information The EXTENSIONEVTBLK structure contains the transmitted information and is referenced via the extevtdatap pointer in the METAEVENT structure associated with the GCEV_EXTENSION event The application at the local end point may also receive an unsolicited GCEV_EXTENSION event with information from the network It is important to note that the EXTENSIONEVTBLK structure referenced in the GCEV_EXTENSION event has a persistence only until the next call of ge_GetMetaEvent In other words any information contained or referenced in the associated EXTENSIONEVTBLK structure must be either processed or copied in the application or risk having the memory space containing the actual information lost on the next ge_GetMetaEvent call Technology Specific User Information The gc_GetUserInfo E1 T1 and ISDN technologies only and gc_SetUserInfo all technologies functions permits the application to retrieve and configure user information for the specified line device that is transmitted to or received from the remote side The actual content and format of the user information is technology or protocol specific or both Refer to the associated technology s Global Call Technology Guide for details on the format of the user information supported and the proper usage of the gc_GetUserInfo and gc_SetUserInfo functions One typ
129. nderstand the impact on the operation of itself or other target objects after change of parameters 4 Select the appropriate programming mode timeout and update condition if applicable to allow Global Call to finish the request efficiently without blocking the application program Figure 26 illustrates the run time configuration procedure Global Call API for HMP on Windows Programming Guide August 2006 117 Real Time Configuration Management n Figure 26 Run Time Configuration Procedure GlobalCall gc_Start Load CCLib gc_CCLibNameToID Get CCLib ID gc_util_insert_parm_ref or Create Target Data for Retrieving gc_util_insert_parm_val CCLib Parameters gc_GetConfigData or ge_SetConfigData Get or Update Parameters of CCLib gc_util_next_parm Read Parameters from the Target Data Block for the gc_GetConfigData Function 1 gc_OpenEx Open a Time Slot and Load a Protocol e gc_QueryConfigData Find the Protocol ID gc_QueryConfigData Find the Parm Info Set ID Parm ID Data Type by CDP Name gc_util_insert_parm_ref or Create Target Data for gc_util_insert_parm_val Retrieving the Protocol Parameters gc_GetConfigData or Get or Change the Parameter Values of a Protocol gc_SetConfigData Read Parameters from the Target Data c_util_next_parm aaa 0 Block for the gc_GetConfigData Function gc_util_insert_parm_ref or gc_util_insert_parm_val Create Target Data for Parame
130. nformation Configured 50 Call Acknowledgement and Call Proceeding Done at Technology Call Control Layer 51 Call Acknowledgement Done by the Technology Call Control Layer and Call Proceeding Done by the Application 2 2 cetn esa neha es eh ahead eee eee eke ee ee ees 52 Basic Asynchronous Outbound Call State Diagram 0 000 ce eee 54 Asynchronous Outbound Call Scenario 2 0 eee eens 58 Asynchronous Outbound Call Scenario With Call Acknowledgement 59 Asynchronous Outbound Call Scenario With Overlap Sending 00000 60 Asynchronous Call Tear Down State Diagram 0 000 cece eee 61 User Initiated Asynchronous Call Termination Scenario 2 2 2 2 0 00 ee 62 Network Initiated Asynchronous Call Termination Scenario 0 0c eee eee 63 Call State Transitions for Hold and Retrieve saaan naua 66 Call State Model for Supervised and Unsupervised Transfers 0000000 ee eeee 68 Call Termination by the Network or Application During a Transfer 2 5 69 Architectural Diagram of Alarm Management Components 00e eee eaee 98 Notification of First and Last Blocking Alarm 1 6 0 cee eee 106 Default Behavior for Alarm Notification 0 00 eee 107 Alarm Transmission ee eae OREERT EDEN EEEE ewe Ree ERRES AAEE 108 Relationship of Customer Application Global Call RTCM and RTCM Parameters 110 Run Time Configuration
131. ng Global Call Topics include general Programming TPS 2 oreo iibh gt beed AGekeheeeiehee hGeaieedbageas 77 e Tips for Programming Drop and Insert Applications 005 78 e Using Global Call with Digital Network Interface Boards 79 5 1 General Programming Tips The following tips apply when programming with Global Call e When using Global Call functions the application must use the Global Call handles that is the line device ID and CRN to access Global Call functions Do not substitute a network voice or media device handle for the Global Call line device ID or CRN If the application needs to use a network voice or media device handle for a specific network or voice library call for example nr_scroute for E1 T1 or ISDN technologies only or dx_play all technologies you must use the ge_GetResourceH to retrieve the network voice or media device handle associated with the specified Global Call line device The gc_GetResourceH function is only needed if the voice or media resource is associated with a Global Call line device If a voice resource is not part of the Global Call line device the device handle returned from the dx_open call should be used e Do not access the underlying call control libraries directly All access must be done using the Global Call library that is using Global Call gc_ functions e Do not call any network library dt_ function directly from
132. ng Guide August 2006 a l ntel Product Description Figure 2 Global Call Architecture for E1 T1 and ISDN Technologies User Application GlobalCall API Other Call Control Library Dialogic Libraries Device Driver Operating Systems Firmware Firmware Network Interface Network Interface 1 3 2 Global Call API The Global Call API is a call control API Similar to other Intel Dialogic APIs such as the Voice API the Global Call API uses the Standard Runtime Library SRL API to deliver response events to its API commands The Global Call API and other Intel Dialogic APIs form a family of APIs that use the underlying services provided by the SRL API The Global Call API provides a collection of functions supporting call control operations as well as functions to support operation administration and maintenance tasks See the Global Call API Library Reference for detailed information about each function Global Call API for HMP on Windows Programming Guide August 2006 21 E Product Description ntel a 1 4 1 4 1 1 4 2 22 Note Call Control Libraries Each supported network technology requires a call control library to provide the interface between the network and the Global Call library The call control libraries currently supported by the Global Call API for HMP are as follows GC_CUSTOM1_LIB The first of two call control library place holders for custom call control libraries Any th
133. ng Guide August 2006 intel Call Control r This chapter describes Global Call capabilities relating to call control Topics include e Call Progress Analysis when Using IP Technology 0005 87 e Call Progress Analysis when Using Digital Network Interface Boards 87 Resouice Route vas come ding ss reaus GOVE CIHR SEE OS SdH REDE ERE SEERA 93 Feature Transparency and BXCnsiONs s lt isceetesesacie er iesgaes eed kebacenes 93 7 1 Call Progress Analysis when Using IP Technology When using IP technology typically packetized messages are used to convey call analysis information See the Global Call IP Technology Guide for more information 7 2 Call Progress Analysis when Using Digital Network Interface Boards Note This section applies to E1 T1 and ISDN technologies only When using Intel NetStructure Digital Network Interface boards Global Call provides a consistent method of pre connect call progress and post connect call analysis across E1 T1 CAS and ISDN protocols The level of support that Global Call provides is described in the following topics e Call Progress Analysis Definition e Configuring Default Call Progress Analysis Parameters e Configuring Call Progress Analysis on a Per Call Basis e Setting Call Analysis Attributes on a Per Call Basis e Configuring Call Progress Analysis on a Per Channel Basis Setting Call Analysis Attributes on a Per Channel Basis e Customizing
134. ng the attributes of an ASO for a specified line device requires detailed knowledge of the given ASO For applications that are using only one known technology the application can use either gc_GetAlarmSourceObjectNetworkID to retrieve the network ASO ID associated with the line device or gc_AlarmSourceObjectNameToID to retrieve the ID for the known ASO Global Call API for HMP on Windows Programming Guide August 2006 103 Alarm Handling i ntel 8 2 4 Note 8 2 5 8 2 5 1 8 2 5 2 104 Starting and Stopping Alarm Transmission This section applies to E1 T1 and ISDN technologies only GCAMS is automatically started when Global Call is started However to begin the transmission of alarms to the remote side the gc_TransmitAlarms function must be called The gc_TransmitAlarms function sends all alarms as specified in the ALARM_LIST data structure for a given alarm source object To stop the transmission of alarms to the remote side use the gec_StopTransmitAlarms function Retrieving Alarm Data The GCAMS database contains the following information e A list by call control library of all the boards that are currently open e Information about each opened board including the board name the call control library ID all open time slots on the board alarm source objects associated with the device and the alarm callback procedure e A list of registered alarm source objects and their attri
135. ng transferred across the telephony network overlap sending or partial dialing This state is optional and may not be supported in all technologies See the appropriate Global Call Technology Guide for information This state applies to E1 T1 and ISDN technologies only Call Proceeding GCST_PROCEEDING This state exists for an outgoing call when the user has received an acknowledgement that all call information necessary to effect call establishment has been received and the call is proceeding The remote side can now accept or answer the call This state is optional and may not be supported in all technologies See the appropriate Global Call Technology Guide for information Call Alerting GCST_ALERTING This state exists for an outgoing call when the calling user has received an indication that remote user alerting has been initiated typically ringing The outbound call has been delivered to the remote party which has not yet answered the call Call Connected GCST_CONNECTED This is a common state that exists for an outgoing call when the user has received an indication that the remote user has answered the call The calling and called parties are connected and the call is therefore active on the related call channel Basic Call States for Call Termination The basic call termination states are as follows Call Disconnected GCST_DISCONNECTED This state indicates that the remote party has disconnected the call The remote party c
136. nnnnnnnnunnnnnnnn OnHoldPendingTransfer Call 1 Note Connected Call 2 Indicates that Call 2 does x aet not apply in a blind transfer GCEV_CONNECTED gc_CompleteTransfer If the network or application terminates a call during a transfer the call state transitions are as shown in Figure 20 68 Global Call API for HMP on Windows Programming Guide August 2006 n Call State Models Figure 20 Call Termination by the Network or Application During a Transfer TERMINATED TERMINATED BY BY NETWORK APPLICATION from any of the states from any of the states shown in the box below 5 shown in the box below Ee ee eee eee eee if Disconnected Call 1 state unchanged Call 2 OnHoldPendingtransfer Call 1 i Dialing Call 2 I OnHoldPendingtransfer Call 1 OnHoldPendingtransfer Call 1 i i I OnHoldPendingtransfer Call 1 i i I Alerting maskable Call 2 J Alerting maskable Call 2 i i OnHoldPendingtransfer Call 1 OnHoldPendingtransfer Call 1 I i i I i i i i i i Dialing Call 2 Connected Call 2 Connected Call 2 Connected Call 1 I i state unchanged Call 1 Connected Call 1 t Disconnected Call 2 OnHoldPendingtransfer Call 2 OnHoldPendingtransfer Call 2 I Meseunedeedavafeneceueewecessadl gc DropGall Calli2 vocee soe e ce cooked GCEV_DROPCALL Call 2 GCEV_CONNECTED Call 1
137. nous mode Asynchronous mode programming is introduced briefly in this chapter and described in more detail in the Standard Runtime Library API Programming Guide Asynchronous Mode Programming Programming in asynchronous mode in Windows is described in the following topics e Asynchronous Model Overview e Asynchronous Model with Event Handlers e Asynchronous with Windows Callback Model e Asynchronous with Win32 Synchronization Model e Extended Asynchronous Programming Model Asynchronous Model Overview Asynchronous mode programming is characterized by the calling thread performing other processing while a function executes At completion the application receives event notification from the SRL and then the thread continues processing the call on a particular channel A function called in the asynchronous mode returns control immediately after the request is passed to the device driver and allows thread processing to continue A termination event is returned when the requested operation completes thus allowing the Intel Dialogic operation state machine processing to continue In general when a function is called in asynchronous mode and an associated termination event exists the gc_Close function should not be called until the termination event has been received In order to disable ge_WaitCall gec_ResetLineDev should be called If this is not done there are potential race conditions under which the application may crash wi
138. ns available library A call control library configured to be recognized by the Global Call API and successfully started by the Global Call gc_Start function B channel A bearer channel used in ISDN interfaces This circuit switched digital channel can carry voice or data at 64 000 bits second in either direction BC See bearer capability bearer capability A field in an ISDN call setup message that specifies the speed at which data can be transmitted over an ISDN line blind dialing Dialing without waiting for dial tone detection blind transfer See unsupervised transfer blocked The condition of a line device initially when it is opened and after a GCEV_BLOCKED event has been received on that line device When a line device is in a blocked condition the application can only perform a limited subset of the Global Call commands on that line device Call related functions may not be called with the exception of gc_DropCall gc_ReleaseCall E1 T1 and ISDN technologies only and gc_ReleaseCallEx Non call related functions are generally allowed See also unblocked below blocking alarm An alarm that causes a GCEV_BLOCKED event to be sent to the application When the application receives a GCEV_BLOCKED event the line device is blocked which means only a limited subset of the Global Call commands are available to the application call analysis When using Intel NetStructure Digital Network Interface boards a term tha
139. nsfer at any point via the ge_DropCall function Global Call API for HMP on Windows Programming Guide August 2006 69 Call State Models i ntel Figure 19 illustrates the call state transitions that occur in an unsupervised transfer which basically includes only e The transition of Call 1 from the Connected to the Idle state invoked by the gc_BlindTransfer function e The transition of Call 1 from the Idle to the Null state invoked by the gc_ReleaseCallEx function 70 Global Call API for HMP on Windows Programming Guide August 2006 intel Event Handling 4 4 1 4 2 This chapter describes how Global Call handles events generated in the call state model Topics include Overview of Event Handling i4caccs ecse ees tbe eee has eR Ede w E ee REDE wR 71 Event C atemGnies 125 6 ee kk Ssa heey hee eee echrathiselibbaiiundiades aves 71 Blocked and Unblocked Event Handle io cc icseetsageiaeeeesgariaadeeawas 72 Bvent a 2s bast E ahd Giese esha e adeeb se seems T3 Events Indicating Errors sreswcedunkid eren iee ase n EA EE 74 Riss Bvenit e215 caceh cate chaomestaeeraketineed dateedaeegecncereney 74 Eyen Hanoi cuss aura pares anknp sdbche shee sade BerseaGsd ees sbe ae awed 74 Overview of Event Handling The Global Call protocol handler continuously monitors the line device for events from the network As each call is processed through its various states corresponding events are generated a
140. object s CCLib ID can be obtained by calling the gc_CCLibNameToID function Global Call Line Device ID t After a line device is opened the CCLib ID and protocol ID if applicable associated with this line device can be obtained by the gc_GetConfigData function with the set ID and parameter ID as GCSET_CCLIB_INFO GCPARM_CCLIB_ID and GCSET_PROTOCOL GCPARM_PROTOCOL_ID Global Call API for HMP on Windows Programming Guide August 2006 Product Description n Table 5 Obtaining Target IDs Target ID Procedure for Obtaining Target ID Global Call CRN After a call target object is created its target object ID that is the Global Call CRN will be an output of the gc_MakeCall function or provided by the metaevent associated with the GCEV_OFFERED event t For E1 T1 and ISDN technologies only 28 Global Call API for HMP on Windows Programming Guide August 2006 intel Programming Models 2 2 1 2 2 2 2 1 Caution This chapter describes the programming models supported by Global Call Topics include Programming Models OVEIMMIOW occ csc x dccdertigasio wees ageans eeseeaeragas 29 Asynchronous Mode Programing s serrresrerssirr s tits ete eReoesiooeseoes 29 Programming Models Overview The Global Call development software supports application development using asynchronous programming models By usage the asynchronous models are often said to use asynchro
141. occurred an unsolicited GCEV_DISCONNECTED event is sent to the application and the call changes to the Disconnected state The result value retrieved for the event will indicate the reason for the disconnection for example an alarm condition occurred Result values are retrieved by calling the ge_ResultInfo function see Section 4 4 Event Retrieval on page 73 The GCEV_BLOCKED event is also sent to the application to indicate that a blocking condition occurred the ge_ResultInfo function can be called to retrieve the reason for the GCEV_BLOCKED event as well Global Call API for HMP on Windows Programming Guide August 2006 99 Alarm Handling i ntel 8 2 2 100 Note Note The GCEV_BLOCKED and GCEV_DISCONNECTED events may arrive in any order When the blocking condition s clears an unsolicited GCEV_UNBLOCKED event is sent to the application indicating complete recovery from the blocking condition When a blocking condition occurs while a line device is in the Null Disconnected or Idle state only the GCEV_BLOCKED event is sent since there is no call to disconnect The call state does not change when a GCEV_BLOCKED or GCEV_UNBLOCKED event is sent to the application In the asynchronous mode if a ge_WaitCall function is pending when a GCEV_UNBLOCKED event is generated the ge_WaitCall function does not need to be reissued The GCEV_BLOCKED and GCEV_UNBLOCKED events are generated for blocking alarms at the
142. on for the event The data structure associated with gc_ResultInfo can contain reason information provided by Global Call and additional reason information provided by the underlying call control library See the Global Call API Library Reference for more information Masking Events Some events are maskable See the ge_SetConfigData function description in the Global Call API Library Reference for specific information regarding enabling and disabling events Event Handlers An event handler is a user defined function called by the SRL to handle a specific event that occurs on a specified device Typically in a Windows environment processing events within a thread or using a separate thread to process events tends to be more efficient than using event handlers However if event handlers are used such as when an application is being ported from Linux then you must use the asynchronous with SRL callback model The following guidelines apply to using event handlers e more than one handler can be enabled for an event The SRL calls all specified handlers when the event is detected e handlers can be enabled or disabled from any thread general handlers can be enabled to handle all events on a specific device e a handler can be enabled to handle any event on any device e synchronous functions cannot be called from a handler By default when the sr_enbhdlr function is first called a thread internal to the SRL is created to ser
143. on may not issue a ge_MakeCall or receive another call while a call is in the On hold state There is no limit to the number of times a call may be placed in and retrieved from the On hold state In addition either the called party or the calling party can put the call in the On hold state The On hold call state applies only to call scenarios where a single call is present on the specified channel The On hold call state does not apply to call transfer scenarios that use the On Hold Pending Transfer call state instead On Hold Pending Transfer State GCST_ONHOLDPENDINGTRANSFER During a supervised call transfer two calls are made accessible to the local channel Both calls must be in the Connected call state The call that is temporarily suspended from conversing is considered to be in the On hold Pending Transfer call state This call is often routed via the local switch or network to receive background music while awaiting completion of the call transfer Both the suspended call and the currently active call may be swapped at any time so that the call that was in the On hold Pending Transfer state is now actively connected while the former active call is placed in the On hold Pending Transfer state There is no limit to the number of times two calls may be swapped between the On hold Pending Transfer and Connected states The completion of the call transfer is independent of which call is active or on hold Call Hold The advanced c
144. on required to proceed with the call is available Minimum Information A minimum amount of destination address information such as DNIS is collected before the call is offered to the application Call State Configuration Some states in the basic call model are optional and can be enabled or disabled selectively Every technology or call control library has a default call state model consisting of all the states it can possibly support from the basic call model If a state is disabled the corresponding call state event will also be disabled If a state is enabled the event mask setting still determines which call state events are sent to the application This configuration can be done by issuing the gc_SetConfigData function with a target_type of GCTGT_GCLIB_CHAN and a target_ID of a line device and passing the appropriate set ID and parameter IDs The set ID used in this context is GCSET_CALLSTATE_MSK and the relevant parameter IDs are GCACT_ADDMSK Enable the call states specified in the value in addition to other states already enabled GCACT_SUBMSK Disable all the call states specified in the value GCACT_SETMSK Enable the call states specified in the value and disable other optional states that are already enabled Global Call API for HMP on Windows Programming Guide August 2006 intel 3 3 2 Note Call State Models The GCACT_ADDMSK GCACT_SUBMSK and GCACT_SETMSK parameter IDs can be assigned one of the follo
145. onal information about the called party number destination number preemptive multitasking A form of multitasking wherein the execution of one thread or process can be suspended by the operating system to allow another thread to execute Windows uses preemptive multitasking to support multiple simultaneous processes PRI Primary Rate Interface An interface at the ends of high volume trunks linking CO facilities and ISDN network switches to each other A T1 ISDN PRI transmits 23 B channels voice data channels and one D channel signaling channel each at 64 Kbps An E1 ISDN PRI transmits 30 B channels one D channel and one framing channel synchronization channel each at 64 Kbps A standard digital telecommunication service available in many countries and most of the United States that allows the transfer of voice and data over T1 or E1 trunks Primary Rate Interface See PRI primary thread See thread process Windows 1 an executing application comprising a private virtual address space code data and other operating system resources such as files pipes and synchronization objects that are visible to the process A process contains one or more threads that run in the context of the process 2 is the address space where the sequence of executable instructions is loaded A process in Windows consists of blocks of code in memory loaded from executables and dynamically linked libraries DLL Each process has its own 4 GB address sp
146. ons describe the components and operation of GCAMS Alarm Management System Components The alarm management system is made up of several components including GCAMS The other components are the customer application s alarm management system AMS and the alarm source objects ASOs ASOs can either reside within a call control library cclib or separate from Global Call API for HMP on Windows Programming Guide August 2006 97 Alarm Handling i ntel a call control library Figure 21 illustrates the relationship between the alarm management system components Figure 21 Architectural Diagram of Alarm Management Components CUSTOMER APPLICATION Operation and Configuration Subsystem Customer AMS GlobalCall Operation and Configuration Subsystem CALL CONTROL LIBRARY ASO optional Network Network Interface Interface The customer application is responsible for configuring the behavior of GCAMS including the designation of which alarms are blocking which alarms the application wants to be notified of and controlling the flow of alarms to the application For more information see Section 8 2 3 Configuration of Alarm Properties and Characteristics on page 101 GCAMS acts as an interface between the customer application and the alarm source objects GCAMS passes requests from the application to the ASOs processes application configuration requests and processes ASO alarm events GCAMS also maintains a da
147. onship of Customer Application Global Call RTCM and RTCM Parameters CUSTOMER APPLICATION Operation and Maintenance Subsystem Customer RTCM GlobalCall RTCM GlobalCall APIs GlobalCall RTCM a GCLib CCLib Protocol Firmware Parameters Parameters Parameters Parameters Each of the components of the RTCM is described in the following sections 110 Global Call API for HMP on Windows Programming Guide August 2006 In 9 2 1 9 2 2 Note Real Time Configuration Management Customer Application Using Global Call RTCM The customer application interfaces with the Global Call RTCM Manager via Global Call RTCM API functions The primary function of an application with regards to RTCM is the maintenance of parameter data It is the application developer s responsibility to understand the impact on system operation before changing a parameter value Specifically the application developer is responsible for the following e Obtaining the information about run time configuration support from the appropriate Global Call Technology Guide Ensuring that the configurable parameters match the target entity and inserting parameter data in the proper data format Choosing the proper Global Call RTCM API control parameters programming mode update condition and timeout to ensure the efficiency of the retrieve or update configuration process and that the application program is not blocked Obtaining the configur
148. or HMP on Windows Programming Guide August 2006 89 Call Control ntel i See the Global Call API Library Reference for more information about the ge_ResultInfo function When an option that enables call analysis is selected aGCEV_MEDIADETECTED event can be received The gc_GetCallInfo function can be used to determine the type of detection by setting the info_id function parameter to CONNECT_TYPE The valuep function parameter indicates the connect type when the function completes Typical values in this context are GCCT_FAX Fax detection GCCT_PVD Positive voice detection PVD GCCT_PAMD Positive answering machine detection PAMD See the Global Call API Library Reference for more information about the ge_GetCallInfo function 7 2 4 Setting Call Analysis Attributes on a Per Call Basis Certain call analysis attributes can be configured on a per call basis using the ge_MakeCall function with an associated GC_PARM_BLK accessible via the GC_MAKECALL_BLK and GCLIB_MAKECALL_BLK structures that contains the CCSET_CALLANALYSIS parameter set ID and one of the following parameter IDs CCPARM_CA_PAMDSPDVAL Positive answering machine detection PAMD speed value Quick or full evaluation of answering machine detection Possible values are e PAMD_FULL Full evaluation of response e PAMD_QUICK Quick look at connection characteristics e PAMD_ACCU Recommended setting Does the most accurate evaluation detecting l
149. ormation driver A software module that provides a defined interface between a program and the hardware Drop and Insert 1 A process where the information carried by a transmission system is demodulated dropped at an intermediate point and different information is entered inserted for subsequent transmission 2 A configuration in which two network interface resources are connected via an internal bus such as the SCbus to connect calls from one network interface to the other A call from one network interface can be dropped to a resource such as a voice resource for processing In return the resource can insert signaling and audio and retransmit this new bit stream via the internal bus and connect the call to a different channel Drop and insert configurations provide the ability to access an operator or another call E1 CAS El line using Channel Associated Signaling In CAS one of the 32 channels time slot 16 is dedicated to signaling for all of the 30 voice channels E1 Another name given to the CEPT digital telephony format devised by the CCITT that carries data at the rate of 2 048 Mbps DS 1 level en bloc mode Mode where the setup message contains all the information required by the network to process the call such as the called party address information event An unsolicited communication from a hardware device to an operating system application or driver Events are generally attention getting messages allowing a pro
150. oup of resources using a single device identifier Certain features such as Feature Transparency and Extension FTE Real Time Configuration Management RTCM and Global Call Service Request GCSR operate on a basic entity called a Global Call target object Target objects are identified by a target type and a target ID The following topics provide more detailed information e Line Device Identifier e Call Reference Number e Object Identifiers and Resource Sharing Across Processes e Target Objects Line Device Identifier A Line Device Identifier LDID is a unique logical number assigned to a specific resource for example a time slot or a group of resources within a process by the Global Call library Minimally the LDID number will represent a network resource For example both a network resource and a voice resource are needed to process an R2 MFC dialing function Using Global Call a single LDID number is used by the application or thread to represent this combination of resources for call control An LDID number is assigned to represent a physical device s or logical device s that will handle a call such as a network interface resource when the gec_OpenEx function is called This identification number assignment remains valid until the ge_Close function is called to close the line device When an event arrives the application or thread can retrieve the LDID number associated with the event by using the linedev field
151. ous Mode E1 T1 and ISDN Technology Application GlobalCall Library Received Connected or GCEV_CONNECTED or Answered Event GCEV_ANSWERED ge_util_insert_parm_ref or Create Target Data for Parameters gc_util_insert_parm_val of the Line Device Set the Parameters if this Timeslot ic_SetConfigData ge 9 0 Target Object in Asynchronous Mode gc_ResetLineDev Force the Line to the NULL State Received RESETLINEDEV Event GCEV_RESETLINEDEV Received SETCONFIGDATA Event GCEV_SETCONFIGDATA The procedure for setting the configuration of a Line Device in asynchronous mode is as follows 1 The channel has an active call Create the target object data that is a GC_PARM_BLK data structure with the appropriate set ID parm ID value size and value buffer by calling the Global Call utility functions See the Global Call API Library Reference for more information 2 Call the ge_SetConfigData function with target_type GCTGT_CCLIB_NETIF GCTGT_PROTOCOL_NETIF GCTGT_FIRMWARE_NETIF GCTGT_CCLIB_CHAN GCTGT_PROTCOL_CHAN or Global Call API for HMP on Windows Programming Guide August 2006 123 Lal Real Time Configuration Management ntel GCTGT_FIRMWARE_CHAN target_id Global Call line device ID time_out 0 mode EV_ASYNC update condition GCUPATE_ATNULL 3 Call the ge_ResetLineDev function to enforce the line to the NULL state 4 If the ge_ResetLineDev function is successful
152. peed 13 Intended AUdIONCE wn c20 ose bu dee de ei Gee eee aR ee deoekeeeeed diane d eaes 13 How to Use This Publication 1 0 2 0 00 cee teas 14 Related Information eseshecedsecees te aed dead gaedad pene la ebb Youd gael ngs 14 1 Product Description 0 c cette ae 17 1 1 Global Call Software Overview 0 0 0 ccc ae 17 1 2 Global Call Feature Categories 2 0 c eee 18 1 2 1 Call Control Features 0 0 0 0 tee 18 1 2 2 Operation Administration and Maintenance Features 00005 18 1 3 Global Call Architecture 2 2 0 tte 19 123 1 OVEWIOW ws Sad briar eoa ie ee behead ee ee Gates dee bei E wdas 19 1 3 2 Global Call APl ires seeds bodes ate oPeaeead wasn E and ane a 21 1 4 Call Control Libraries 1 2 nee 22 1 4 1 Starting Call Control Libraries 1 2 0 0 0 000 ee 22 1 4 2 Call Control Library States 0 2 0 2 eee 22 1 5 Global Call Object Identifiers 0 2 0 0 00 eee 23 1 5 1 Line Device Identifier 0 0 cee eee 24 1 5 2 Call Reference Number 0 000 cece eee 24 1 5 3 Object Identifiers and Resource Sharing Across Processes 25 1 5 4 Target Objects 0 eee eee 25 2 Programming Models 0 00 eee eae 29 2 1 Programming Models Overview 000 0c tet 29 2 2 Asynchronous Mode Programming cece ete tees 29 2 2 1 Asynchronous Model Overview 00000 cee eee
153. plication but all media processing takes place on the host processor In this document the term board represents the virtual DM3 board unless explictly noted otherwise Intel NetStructure Digital Network Interface boards provide physical E1 and T1 interfaces for applications that require E1 T1 network connectivity Applicability This document is published for Intel NetStructure Host Media Processing Software Intended Audience This publication is written for the following audience e Distributors e System Integrators Toolkit Developers e Independent Software Vendors ISVs e Value Added Resellers VARs Global Call API for HMP on Windows Programming Guide August 2006 13 a About This Publication ntel z Original Equipment Manufacturers OEMs How to Use This Publication Refer to this publication after you have installed the hardware and the system software which includes the Global Call software This publication assumes that you are familiar with the Windows operating system and the C programming language The information in this guide is organized as follows Chapter 1 Product Description provides an overview of the Global Call development software Chapter 2 Programming Models describes the supported programming models in the Windows environment Chapter 3 Call State Models describes the call state models used by Global Call Chapter 4 Event Handling describes how to h
154. processing Windows 74 events CRN in METAEVENT structure 73 LDID association 24 non Global Call events 73 reason code 73 retrieving 73 Global Call API for HMP on Windows Programming Guide August 2006 151 exiting an application programming tips 77 extended asynchronous programming model Windows 30 31 F Features call control 18 operation administration and maintenance 18 firmware 112 firmware module 112 G gc_BlindTransfer _ 67 gc_Close _ LDID becomes invalid 24 programming tips 77 gc_CompleteTransfer _ 67 gc_DropCall _ 61 programming tips 77 gc_GetMetaEvent _ 30 31 73 75 gc_GetMetaEventEx _ 32 73 caution re Multiple threads 32 programming tips 78 gc_GetResourceH _ programming tips 77 gc_HoldCall _ 65 gc_OpenEx _ LDID assignment 24 gc_ReleaseCallEx _ 25 62 programming tips 77 gc_ResultInfo _ 73 85 99 gc_RetrieveCall _ 65 GC_RTCM_EVTDATA data structure 116 gc_SetConfigData _ 64 gc_SetupTransfer _ 67 gc_SwapHold _ 67 gc_WaitCall _ 100 GCEV_UNBLOCKED event 100 gcerr h header 85 GCEV_ALARM 100 GCEV_ALARM events 101 GCEV_BLOCKED 99 GCEV_BLOCKED event Alarm On condition 99 GCEV_DISCONNECTED event asynchronous call termination 61 sent when alarm occurs 99 GCEV_GETCONFIGDATA_FAIL event 85 GCEV_SETCONFIGDATA event 85 GCEV_TASKFAIL error indicating event 74 GCEV_TASKFAIL event 85 GCEV_UNBLOCKED 99 GCEV_UNBLOCKED event Alarm Off condition 100 with gc_WaitCall _
155. r valid Object Identifiers and Resource Sharing Across Processes The CRNs and LDIDs assigned by the Global Call API library can not be shared among multiple processes These assigned CRNs and LDIDs remain valid only within the process invoked That is for call control purposes you should not open the same physical device from more than one process nor from multiple threads in a Windows environment Unpredictable results may occur if this advice is not followed Target Objects A target object provides a way of identifying a particular entity that is maintained by a specific software module In API function calls the target object is specified by a pair of parameters the target_type and target_ID target_type Identifies the kind of software module and the entity that it maintains For example the target type GCTGT_GCLIB_CHAN represents the Global Call Library and a channel entity that it maintains target_ID Identifies the specific target object such as a line device ID LDID which is generated by Global Call at runtime Table 2 shows the combinations of physical or logical entities and software module entities that can make up a target type target_type Table 2 Supported Target Types Global Call API for HMP on Windows Programming Guide August 2006 Entity Software Module System Network Interface Channel CRN GCLib S S S S CCLib S S S S Protocol SV SV SV Firmware SV SV S Suppor
156. red in the ALARM_LIST data structure To retrieve the status of the current alarm configuration use the ge_GetAlarmConfiguration function Configuring Alarm Parameters The gc_SetAlarmParm function is used to set alarm parameters that control ASO parameters such as timing An example of a timing parameter would be setting how long a loss of Global Call API for HMP on Windows Programming Guide August 2006 8 2 3 5 Note Alarm Handling synchronization must be present before the ASO declares a loss of sync alarm or alarm handling mode Use of the gc_SetAlarmParm function as well as the ge_GetAlarmParm function is highly alarm source object dependent and requires detailed knowledge of the underlying ASO technology by the application writer For a description of ASOs that are common across multiple technologies see the Global Call API Library Reference Alarm Configuration Tips The procedures for configuring alarms depends on whether the application writer is configuring the behavior of alarm source objects or specific line devices associated with a given alarm source object When a line device is opened it takes the blocking and notify attributes of the network ASO if any associated with the given line device The default configuration that is the flow blocking and notify attributes of an alarm source object can be changed by using the ge_SetAlarmFlow and gc_SetAlarmConfiguration functions Typical
157. rocess A and then closed process B is then allowed to open the same channel However since closing a channel is an asynchronous operation when using R4 there is a small gap between the time when the xx_close function returns in process A and the time when process B is allowed to open the same channel If process B opens the channel too early things could go wrong For this reason this type of sequence should be avoided 5 3 2 4 Initializing an Application Flexible Routing A device must first be opened in order to obtain its handle which can then be used to access the device functionality Since applications use Global Call for call control that is for call setup and tear down all Intel network interface devices must be opened using the ge_OpenEx function Note When call control is not required such as with ISDN NFAS dt_open can be used to open DM3 network interface devices Once the call has been established voice and or data streaming should be done using the Voice API Functions such as dx_playiottdata dx_reciottdata and dx_dial can be used Of course in order to do so the voice device handle must be obtained 5 3 2 5 Initializing Global Call Flexible Routing This scenario is one where an application uses Digital Network Interface boards in a flexible routing configuration When initializing an application to use boards based on the DM3 architecture you must use Global Call to handle the call control T
158. ronous mode for IP technology is as follows 1 The channel has an active call Create the target object data that is a GC_PARM_BLK data structure with the appropriate set ID parm ID value size and value buffer by calling the Global Call utility functions See the Global Call API Library Reference for more information 2 Call the gc_SetConfigData function with target_type GCTGT_CCLIB_NETIF target_id Global Call line device ID time_out 0 mode EV_ASYNC update condition GCUPATE_ATNULL 3 If the gc_SetConfigData function is successful a GCEV_SETCONFIGDATA event is received If the GCEV_SETCONFIGDATA_FAIL event is received call the gc_ResultInfo function to find the error and correct it Global Call API for HMP on Windows Programming Guide August 2006 125 a Real Time Configuration Management l ntel A 126 Global Call API for HMP on Windows Programming Guide August 2006 intel Handling Service Requests 10 This chapter describes the Global Call Service Request GCSR feature Topics include the following Service Request QVGWVIEW 26 lt a sista vot kannt Etter ARA ERANA a EEA 127 Service Regest Componemis os 2 lt iike rtt seuedeentiveniehade EINE ER 128 Dervis Request Dali sii coe ee tawae Rone EEA E ERA SREE we 129 General Service Request SCCNANG incu win do iite ends baat ee ened oud was 129 10 1 Service Request Overview The Global Call Service Request GCSR feature is an optional fe
159. rred call to party C Global Call API for HMP on Windows Programming Guide August 2006 131 Using Global Call to Implement Call Transfer Figure 34 Blind Call Transfer Unsupervised Transfer Transferring Transferred Party A Party B ik of Transferred_ To_Party C Before Blind Transfer aay peel Party A Party B fk om og Call 2 Transferred_ To_Party C Blind Call Transfer 11 1 2 Supervised Call Transfer intel Transferring Transferred Party A Party B Transferred_ To_Party C After Blind Transfer In a supervised call transfer scenario party A transfers the call between A and B Call 1 to a call between party B and C after establishing a consultation call with party C In this call party A informs Transferred to party C of the intent of transferring party B to party C and collects the feedback and rerouting address from party C Party A requests that party B dial party C s address rerouting address and then disconnect from Calls 1 and 2 after Call 3 Transferred to call between party B and party C has been established Before call transfer can occur party A must be in a call with party B Primary Call Call 1 Figure 35 Supervised Call Transfer ka Transferred Transferring Transferred Transferring Transferred Transferring Transferred Party A e
160. s Each call to the sr_enbhdlr function allows the Intel Dialogic events to be serviced when the operating system schedules the SRL handler thread for execution The SR_MODELTYPE value must not be set to SR_STASYNC because the SRL handler thread must be created by the sr_enbhdIr call The event handler must not call the sr_waitevt function or any synchronous Intel Dialogic function Global Call API for HMP on Windows Programming Guide August 2006 2 2 3 2 2 4 2 2 5 Programming Models Individual handlers can be written to handle events for each channel The SRL handler thread can be used when porting applications developed for other operating systems Asynchronous with Windows Callback Model The asynchronous with Windows callback model allows an asynchronous application to receive SRL event notification through the standard Windows message handling scheme This model is used to achieve the tightest possible integration with the Windows messaging scheme Using this model the entire Intel Dialogic portion of the application could be run on a single thread This model calls the sr_NotifyEvt function once to define a user specified application window handle and a user specified message type When an event is detected a message is sent to the application window The application responds by calling the sr_waitevt function with a 0 timeout value For Global Call events and optionally for non Global Call events the application
161. s include digital network interface devices Network resources are assigned to telephone lines calls on a dedicated or a shared resource basis Network resources control the signal handling required to manage incoming calls from the network and the outgoing calls to the network NCAS Non Call Associated Signaling Allows users to communicate by user to user signaling without setting up a circuit switched connection this signal does not occupy B channel bandwidth A temporary signaling connection is established and cleared in a manner similar to the control of a circuit switch connection Since NCAS calls are not associated with any B channel applications receive and transmit NCAS calls on the D channel line 146 Global Call API for HMP on Windows Programming Guide August 2006 intel device Once the NCAS connection is established the application can transmit user to user messages using the CRN associated with the NCAS call Network Facility Associated Signal See NFAS NFAS Network Facility Associated Signaling Allows multiple spans to be controlled by a single D channel subaddressing Non Call Associated Signal See NCAS NSI Network Specific Information message NT1 Network Terminator The connector at either end of an ISDN link that converts the two wire ISDN circuit interface to four wires null A state in which no call is assigned to the device line or time slot overlap viewing A condition of waiting for additi
162. s in Asynchronous Mode 3 4 2 1 Outbound Calls in Asynchronous Mode Overview Figure 11 illustrates a basic Outbound Call Model which shows the call states associated with establishing a call in the asynchronous mode All calls start from a Null state The call establishment process for outbound calls is shown Table 7 presents a summary of the outbound call state transitions Global Call API for HMP on Windows Programming Guide August 2006 53 Call State Models i ntel Figure 11 Basic Asynchronous Outbound Call State Diagram gc_MakeCall GCEV_DIALING maskable GCEV_REQMOREINFO or gc_SendMorelnfo GCEV_SENDMOREINFO GCEV_ALERTING gc_SendMorelnfo GCEV_SENDMOREINFO GCEV_REQMOREINFO vy ttteseneeenne GCEV_PROCEEDING ouenenenenenne Proceeding s0rsetrseeessenerce a aaa SendMorelnfo GCEV_ALERTING l Ki r N GCEV_ALERTING a ve GCEV_CONNECTED aan een i we Alerting i pern Comnnmnnnenem CEV_CONNECTED i Taes F 4 GCEV_CONNECTED e OS Legend Required org Optional Note In Figure 11 the SendMorelInfo state and all transitions to from that state apply to E1 T1 and ISDN technologies only 54 Global Call API for HMP on Windows Programming Guide August 2006 Table 7 Asynchronous Outbound Call State Transitions Call State Models State Previous Next State Valid Call State Transition Functions Call Transition Events Alerting GCS
163. s received For voice function information see the Voice API Library Reference for your operating system Using Global Call with Digital Network Interface Boards The HMP software can be used in conjunction with Intel NetStructure Digital Network Interface boards that provide physical E1 and T1 interfaces These Digital Network Interface boards are based on the DM3 architecture Global Call supports the development of applications that use these boards The following topics provide guidelines for using Global Call with Digital Network Interface boards e Routing Overview e Working with Flexible Routing Configurations e Handling Multiple Call Objects Per Channel in a Glare Condition Routing Overview The HMP software supports flexible routing configurations With flexible routing the resource devices voice fax media and network interface devices are independent which allows exporting and sharing of the resources Global Call API for HMP on Windows Programming Guide August 2006 79 Lal Application Development Guidelines ntel z 5 3 2 5 3 2 1 80 Working with Flexible Routing Configurations The following topics provide more information about using Global Call with Digital Network Interface boards that use the flexible routing configuration e Determining Channel Capabilities Flexible Routing e Using Device Handles Flexible Routing e Multi Threading and Multi Processing Flexible Routing Initializing an Applic
164. state GCEV_DISCONNECTED gt Disconnected state GCEV_DROPCALL gt Idle state t Applies to E1 T1 and ISDN technologies only gc_SendMorelnfo gc_DropCall GCEV_DISCONNECTED GCEV_DROPCALL GCEV_PROCEEDING GCEV_CONNECTED Global Call API for HMP on Windows Programming Guide August 2006 55 Call State Models i ntel 3 4 2 2 3 4 2 3 3 4 2 4 3 4 2 5 3 4 2 6 56 The following sections describe the asynchronous outbound call processes as shown in Figure 11 Basic Asynchronous Outbound Call State Diagram on page 54 Channel Initialization To establish calls the following conditions must be met e The condition of the line device must be unblocked When a channel is initially opened the initial condition of a line device is blocked A blocking condition on a line device is indicated by the reception of aGCEV_BLOCKED event and an unblocking condition on a line device is indicated by the reception of aGCEV_UNBLOCKED event The GCEV_BLOCKED and GCEV_UNBLOCKED events are sent as unsolicited events to the application in response to blocking alarms For more information on blocking alarms and the GCEV_BLOCKED and GCEV_UNBLOCKED events see Section 4 3 Blocked and Unblocked Event Handling When the condition of the line device is unblocked the line device is ready for establishing calls e The call state of the channel must be in the Null state This is the initial cal
165. state GCEV_DROPCALL gt Idle state gc_CallAck gc_AnswerCall gc_AcceptCall gc_DropCall GCEV_DISCONNECTED GCEV_DROPCALL GCEV_ACCEPT GCEV_ANSWERED GCEV_MOREINFO f GCEV_CALLPROC t Applies to E1 T1 and ISDN technology only The following sections describe the asynchronous inbound call processes Channel Initialization To establish calls the following conditions must be met e The condition of the line device must be unblocked When a channel is initially opened the initial condition of a line device is blocked A blocking condition on a line device is indicated by the reception of aGCEV_BLOCKED event and an unblocking condition on a line device is indicated by the reception of aGCEV_UNBLOCKED event The GCEV_BLOCKED and GCEV_UNBLOCKED events are sent as unsolicited events to the application in response to blocking alarms GCEV_BLOCKED and GCEV_UNBLOCKED events are related to layer 1 alarms as well as to channel states service status in T1 ISDN bit states in CAS GCEV_BLOCKED and GCEV_UNBLOCKED are used as what might be termed flow control events within the application For more information on blocking alarms and the GCEV_BLOCKED and GCEV_UNBLOCKED events see Section 4 3 Blocked and Unblocked Event Handling When the condition of the line device is unblocked the line device is ready for establishing calls The call state of the channel must be in the Null state This is
166. state transitions A call can be terminated by the application or by the detection of a call disconnect from the network Either of these terminations can occur at any point in the process of setting up a call and during any call state Figure 15 Asynchronous Call Tear Down State Diagram Note In Figure 15 the GetMoreInfo and SendMorelInfo states apply to E1 T1 and ISDN technologies only Table 8 Asynchronous Call Termination Call State Transitions 3 4 3 2 3 4 3 3 State Previous Next State TE Ga Siate Call Transition Events Transition Functions Disconnected Previous Offered Accepted gc_DropCall GCEV_DROPCALL GCEV_DISCONNECTED Connected Dialing Not maskable SendMorelnfo Proceeding Alerting GetMorelnfo t CallRouting Next GCEV_DROPCALL gt Idle state Idle GCST_IDLE Previous Offered Accepted gc_ReleaseCallEx GCEV_RELEASECALL Not Maskable Connected Dialing SendMorelnfo Proceeding Alerting GetMorelnfo t CallRouting Disconnected Next GCEV_RELEASECALL gt Null t Applies to E1 T1 and ISDN technologies only User Initiated Termination The application terminates a call by issuing a ge_DropCall function that initiates disconnection of the call specified by the CRN When the remote side responds by disconnecting the call a GCEV_DROPCALL event is generated and causes a transition from the current call state to the Idle state The user must then issue
167. supported This function is supported in asynchronous mode and can operate on a board device only In addition the Global Call RTCM returns an error value when the function returns in synchronous mode or generates a Global Call event related to the Global Call RTCM in asynchronous mode Since the Global Call RTCM may not have any knowledge about configurable parameters defined or used in individual modules it passes the configuration request to the software module in which Global Call API for HMP on Windows Programming Guide August 2006 111 Lal Real Time Configuration Management ntel 9 2 3 9 3 112 the target object is located The customer application must ensure that the target object and requested parameters match RTCM Parameters The third component of the RTCM feature are the RTCM Parameters The parameters are defined and maintained in four categories of software modules Global Call Library GCLib Call Control Library CCLib Protocol and Firmware Each software module supports different target objects as well as the target objects parameters Using RTCM Parameters The Global Call RTCM provides a generic way of getting E1 T1 and ISDN technologies and setting all technologies the configuration information for a target object The target objects and their parameters are defined and maintained in the following categories of software modules Parameters in GCLib Module parameters that are defined in
168. synchronous Mode Upon completion of the function call the Global Call application receives the GCEV_GETCONFIGDATA event if all requested parameters have been successfully retrieved Otherwise the Global Call application receives the GCEV_GETCONFIGDATA_FAIL event which means at least one requested parameter of this request failed to retrieve due to an error The METAEVENT data structure associated with both events has a field evtdatap that points to a GC_RTCM_EVTDATA data structure In the GC_RTCM_EVTDATA event the retrieved _parmblkp field points to the retrieved parameter data The error value and additional message describing the parameter and the error are also provided in GC_RTCM_EVTDATA data structure The ge_GetConfigData function cannot be called in asynchronous mode for the following target types GCTGT_GCLIB_SYSTEM GCTGT_CCLIB_SYSTEM GCTGT_PROTOCOL_SYSTEM and GCTGT_FIRMWARE_SYSTEM The function returns invalid target type The ge_GetConfigData function must be called in synchronous mode for these target types gc_SetConfigData all technologies Synchronous Mode Upon completion of the function call the ge _SetConfigData function returns a value of GC_SUCCESS to indicate that all requested parameters in a given target object have been successfully updated Any other return value indicates that at least one requested parameter in a target object failed to be updated due to an error The gc_ErrorInfo function is called imme
169. t Much of the information contained in this document was previously published in the Global Call API for Windows Operating Systems Programming Guide document number 05 1867 002 Global Call API for HMP on Windows Programming Guide August 2006 11 Revision History ntel 12 Global Call API for HMP on Windows Programming Guide August 2006 intel About This Publication The following topics provide information about this publication e Purpose e Intended Audience e How to Use This Publication e Related Information Purpose This publication provides guidelines for using the Global Call API to build computer telephony applications that require call control functionality Such applications include but are not limited to Call Routing Enhanced Services Unified Messaging Voice Messaging LAN Telephony Services Computer Telephony Services Switching PBX Interactive Voice Response Help Desk and Work Flow applications This publication is a companion guide to the Global Call API Library Reference that provides details on the functions and parameters in the Global Call API library and the Global Call Technology Guides that provide IP E1 T1 and ISDN specific information Host Media Processing HMP software performs media processing tasks on general purpose servers based on Intel architecture without the need for specialized hardware When installed on a system HMP performs like a virtual DM3 board to the customer ap
170. t any point in the call establishment process that is if a GCEV_TASKFAIL event is received by the application the call stays in its current state In most cases the application needs to drop and release the call to return the line device to the Null state However in some cases such as call failure due to a trunk error the application needs to use Global Call API for HMP on Windows Programming Guide August 2006 ntel Call State Models the gc_ResetLineDev function to reset the line device to the Null state For more information see the gc_DropCall gc_ReleaseCallEx and gc_ResetLineDev function descriptions in the Global Call API Library Reference 3 4 1 10 Abandoned Calls During call establishment the remote side may choose to hang up before call setup has been completed The application must be capable of handling error conditions and the lack of complete information when requesting call information Note The GCEV_DETECTED event is not supported If the host application has not received a GCEV_OFFERED event when the call is disconnected by the remote side the host application will not receive any event If the host application has already received a GCEV_OFFERED event it receives a GCEV_DISCONNECTED event when the call is disconnected 3 4 1 11 Inbound Call Scenarios in Asynchronous Mode This section shows various asynchronous inbound call scenarios For call scenarios used by a specific signaling protocol check
171. t describes the activity that occurs after a call is connected post connect such as voice detection and answering machine detection Compare to call progress call control The process of setting up a call and call tear down Global Call API for HMP on Windows Programming Guide August 2006 143 a ntel e call control library A collection of routines that interact directly with a network interface These libraries are used by the Global Call functions to implement network specific commands and communications call progress When using Intel NetStructure Digital Network Interface boards a term that describes the activity that occurs before a call is connected pre connect such as busy or ringback Compare to call analysis call progress analysis When using Intel NetStructure Digital Network Interface boards a collective term for call progress and call analysis See also call progress and call analysis call progress tone When using E1 T1 and ISDN technologies a tone sent from the PTT to tell the calling party the progress of the call for example a dial tone busy tone or ringback tone The PTT s can provide additional tones such as a confirmation tone splash tone or a reminder tone to indicate a feature in use Call Reference Number CRN A number assigned by the Global Call library to identify a call on a specific line device call states Call processing stages in the application CAS Channel Associated S
172. t scheme for features such as call transfer See the Global Call IP Technology Guide Call Progress and Call Analysis Provides the capabilities for handling pre connect Call Progress information that reports the status of the call connection such as busy no dial tone or no ringback and post connect Call Analysis information that reports the destination party s media type for example voice answering machine or fax modem This information is determined by the detection of tones defined specifically for this purpose See Section 7 2 Call Progress Analysis when Using Digital Network Interface Boards for more information The call progress and call analysis feature applies only to E1 T1 and ISDN technologies not IP technology Feature Transparency and Extension FTE Provides the ability to extend the capabilities of Global Call to handle features that are specific to a particular technology so that those features are accessible via the Global Call interface For example for ISDN applications Global Call supports supplementary services such as Overlap Send Overlap Receive Any Message Any IE and User to User messaging See Section 7 4 Feature Transparency and Extension for more information Operation Administration and Maintenance Features The Global Call development software provides the following features that facilitate the operation administration and maintenance of Global Call applications Error Handling Function
173. t this time to be examined so that the application can determine the appropriate action to take with regards to the call Get More Information GCST_GETMOREINFO This state exists for an incoming call when the network has received an acknowledgement of the call establishment request which permits the network to send additional call information if any in the overlap mode The application is waiting for more information typically called party number digits This state is optional and may not be supported in all technologies See the appropriate Global Call Technology Guide for information This state applies to E1 T1 and ISDN technologies only Call Routing GCST_CALLROUTING This state exists for an incoming call when the user has sent an acknowledgement that all call information necessary to effect call establishment has been received The acknowledgement can be sent from the Offered or the GetMorelInfo state if all the information has been received This transition typically involves the sending of Call Routing tones or technology specific messages for example in the case of ISDN a CALL_PROCEEDING message is sent The application can now accept or answer the call This state is optional and may not be supported in all technologies See the appropriate Global Call Technology Guide for information Call Accepted GCST_ACCEPTED This state indicates that the incoming call was offered and accepted by the application The user on the inbound s
174. tabase of the current configuration attributes by alarm source object and line device In addition GCAMS implements the ASOs that are common across multiple technologies For more on the operation and configuration of GCAMS see Section 8 2 Operation and Configuration of GCAMS on page 99 The final components of the alarm management system are the ASOs ASOs are responsible for generating alarm events when alarms occur and then clear If configured to do so ASOs are also 98 Global Call API for HMP on Windows Programming Guide August 2006 8 2 8 2 1 Note Alarm Handling responsible for starting and stopping the transmission of alarms and setting and getting alarm parameters such as timing parameters Operation and Configuration of GCAMS The primary functions of GCAMS are as follows e Generation of Events for Blocking Alarms e Generation of Alarm Events e Configuration of Alarm Properties and Characteristics e Starting and Stopping Alarm Transmission E1 T1 and ISDN technologies only e Retrieving Alarm Data Generation of Events for Blocking Alarms Global Call alarms are classified as either blocking or non blocking Blocking alarms are alarms that cause the application to become blocked and potentially generate a GCEV_BLOCKED event when the alarm is set the alarm on condition is detected Subsequently all blocking alarms generate a GCEV_UNBLOCKED event when the alarm clears the alarm off condi
175. te transitions that occur during a supervised transfer are shown in Figure 19 which also shows the call state transitions for an unsupervised transfer Global Call API for HMP on Windows Programming Guide August 2006 67 Call State Models n Figure 19 Call State Model for Supervised and Unsupervised Transfers INBOUND CALL OUTBOUND CALL gc_ReleaseCallEx Call 1 gc_ReleaseCallEx Call 2 gc_WaitCall GCEV_DETECTED maskable s gc_ReleaseCallEx Call 1 Q oan ae ennunuunnnnunnnnnnny Detected Call 1 tanunununnnnnnnnnnns 1 gc_MakeCall v Offered Call 1 Dialing Call 1 Idle Call 1 gc_AcceptCall Aar ArT aa v ennnnnnnnunnnnnnnnng Accepted Call 1 X Alerting Call 1 tannununnnnnnnunnnan l i i gc_AnswerCall gc_AnswerCall Regn v Connected Call 1 GCEV_OFFERED gc_BlindTransfer GCEV_CONNECTED gc_SetupTransfer sr_waitevt GCEV_SETUPTRANSFER gc_CompleteTransfer GCEV_COMPLETETRANSFER i Idle Call 1 OnHoldPendingTransfer Call 1 Idle Call 2 Dialtone Call 2 gc_CompleteTransfer gc_MakeCall gc Complete Transfer gc_CompleteTransfer OnHoldPendingTransfer Call 1 Connected Call 1 Dialtone Call 2 OnHoldPendingTransfer Call 2 a ge_SwapHold GCEV CONNECTED GCEV_ALERTING a BE maskable Pere re OnHoldPendingTransfer Call 1 Alerting Call 2 7S munununun
176. ted SV Supported with Variances see the appropriate Global Call Technology Guide for more information The possible software modules include e GCLib e CCLib e Protocol 25 E Product Description ntel a e Firmware The possible entities include System NIC for IP technology all physical boards for E1 T1 and ISDN technologies Network Interface logical board or virtual board Channel time slot CRN call reference number A target type target_type name is composed of the prefix GCTGT which stands for Global Call Target a software module name such as GCLIB and an entity name such as NETIF For example the target type GCTGT_GCLIB_NETIF indicates that the desired target type is a network interface maintained by the Global Call library A target ID target_ID identifies the specific object that is located within the category defined by the target type target_type A target ID can be any of the following e line device ID LDID e call reference number CRN e Global Call library ID GCGV_LIB e call control library ID CCLib ID e protocol ID The types and IDs for target objects are defined at the Global Call level Table 3 shows the target types as described in Table 2 with various target IDs to represent valid target objects Table 3 Target Types and Target IDs Target Type Target ID Description GCTGT_GCLIB_SYSTEM GCGV_LIB Global Call library module target object GC
177. ted Events 0 0 eae 64 3 5 Advanced Call Control with Call Hold and Transfer 0 0000 e eee eee 64 3 5 1 Advanced Call State Model Overview 00 00 aaaea 64 3 5 2 Advanced Call States for Hold and Transfer 0000 c eee eee 65 S535 CalltAold os yet iowa tied oor he a ae ea Lg Pa Sem a ee ok 65 3 54 Call Tranter soie eek o bates aa eaa eG Sion SUA Nae a a eae ad Soha Sse 66 4 Event Handling oo cre geen ee eh eee d a ya caine Gripen Ee ee reek Foner aden 71 4 1 Overview of Event Handling 0 c cee 71 4 2 EVent Categories sca isce ta a sae ke Rha eae To eos Pade ow AVe Soe eae as 71 4 3 Blocked and Unblocked Event Handling 0 e eee eee 72 AA Event Retrieval hcsesas hana oie 2 eave Pe EE Hale deste weg E RE vend deeded 73 4 5 Events Indicating Errors 2 2 0 0 eee 74 4 6 Masking Events sre rida a nE ERA nas 9 RA ADRE n EA Mahe oe eee eee a 74 4 7 JEventHandlers wc evade e Debt vee e N a deeb eythe a e E 74 5 Application Development Guidelines 0 000 ccc eee 77 5 1 General Programming TipS 0000 c ce eae 77 5 2 Tips for Programming Drop and Insert Applications 0 00 0 eee 78 5 3 Using Global Call with Digital Network Interface Boards 0 000 ea eeae 79 5 35 Routing Overview yeri vee ug dae ponent ede Oe Pen ea lied 79 5 3 2 Working with Flexible Routing Configurations 000 cece
178. terface time slot device handle that is associated with the line device Set up TDM bus full duplex routing between the network interface device and voice device e Use nr_scroute FULL DUPLEX e Alternatively if you specified the voice device name in the devicename parameter in step 2 the network interface device and voice device are automatically routed on the TDM bus by nature of the ge_OpenEx Repeat steps 2 to 6 for all Global Call device line devices Global Call API for HMP on Windows Programming Guide August 2006 In 5 3 2 6 5 3 2 7 5 3 3 Application Development Guidelines Device Initialization Hint Flexible Routing In some applications when xx_open functions Global Call Voice Fax are issued asynchronously it may cause slow device initialization performance Fortunately you can avoid this particular problem quite simply by reorganizing the way the application opens and then configures devices The recommendation is to do all xx_open functions for all channels before proceeding with the next function For example you would have one loop through the system devices to do all the xx_open functions first and then start a second loop through the devices to configure them instead of doing one single loop where an xx_open is immediately followed by other API functions on the same device With this method by the time all xx_open commands are completed the first channel will be initialized so
179. ters of a Line Device gc_GetConfigData or Get or Change Parameter Values of a Line Device gc_SetConfigData gc_util_next_parm Read Parameters from the Target Data Block for the gc_GetConfigData Function Note In Figure 26 for IP technology only the ge_SetConfigData function is supported for changing the parameter values of a board device See Section 9 7 3 Getting or Setting Line Device Configuration in Synchronous Mode on page 121 9 7 Sample Scenarios Using the RTCM API Functions This section shows the following examples in which the customer application uses the Global Call RTCM API functions to get or set the configuration of various target objects With the exception of the last example all of these apply to E1 T1 and ISDN technologies only The examples include e Getting or Setting GCLib Configuration in Synchronous Mode e Getting or Setting CCLib Configuration in Synchronous Mode 118 Global Call API for HMP on Windows Programming Guide August 2006 a ntel Real Time Configuration Management e Getting or Setting Line Device Configuration in Synchronous Mode e Setting Line Device Configuration in Asynchronous Mode e Setting Board Device Configuration in Asynchronous Mode IP Technology 9 7 1 Getting or Setting GCLib Configuration in Synchronous Mode Note This section applies to E1 T1 and ISDN technologies only The Global Call RTCM feature allows the customer application to retrie
180. th A group of data structure elements usually share a common purpose or functionality device handle Numerical reference to a device obtained when a device is opened This handle is used for all operations on that device See also Call Reference Number 144 Global Call API for HMP on Windows Programming Guide August 2006 intel DDI string A string of Direct Dialing In digits that identifies a called number DLL Dynamically Linked Library In Windows environments a sequence of instructions dynamically linked at runtime and loaded into memory when they are needed These libraries can be shared by several processes device Any computer peripheral or component that is controlled through a software device driver device channel An Intel Dialogic data path that processes one incoming or outgoing call at a time Compare to time slot digital channel Designates a bi directional transfer of data for a single time slot of a T1 or an E1 digital frame between a T1 E1 device that connects to the digital service and the SCbus Digitized information from the T1 E1 device is sent to the SCbus over the digital transmit channel The response to this call is sent from the SCbus to the T1 E1 device over the digital receive listen channel DNIS Dialed Number Identification Service A feature of 800 lines that allows a system with multiple 800 lines in its queue to access the 800 number the caller dialed Also provides caller party number inf
181. th a segmentation fault Functions may be initiated asynchronously from a single thread and or the completion termination event can be picked up by the same or a different thread that calls the sr_waitevt Global Call API for HMP on Windows Programming Guide August 2006 29 Lal Programming Models ntel 3 2 2 2 30 Note and gc_GetMetaEvent functions When these functions return with an event the event information is stored in the METAEVENT data structure The event information retrieved determines the exact event that occurred and is valid until the sr_waitevt and gc_GetMetaEventt functions are called again For Windows environments the asynchronous models provided for application development also include e asynchronous model with event handlers e asynchronous with Windows callback e asynchronous with Win32 synchronization e extended asynchronous programming The asynchronous programming models are recommended for more complex applications that require coordinating multiple tasks Asynchronous model applications typically run faster than synchronous models and require lower levels of system resources Asynchronous models reduce processor loading because of the reduced number of threads inherent in asynchronous models and the elimination of scheduling overhead Asynchronous models use processor resources more efficiently because multiple channels are handled in a single thread or in a few threads See Section 5 1
182. th an active call This parameter does not apply to the gc_GetConfigData function Programming Mode The customer application can specify whether to access configurations in the asynchronous mode or synchronous mode The following describe how the ge_GetConfigData and gc_SetConfigData functions operate in the asynchronous and synchronous programming modes gc_GetConfigData E1 T1 and ISDN technologies only Synchronous Mode Upon completion of the function call the retrieved parameter data is still in the original GC_PARM_BLK data block after the ge_GetConfigData function returns The function s return value GC_SUCCESS indicates that all requested parameters in a given target object have been successfully retrieved Other return values indicate that at least one requested parameter in the target object failed to be retrieved due to an error The gc_ErrorInfo function is called immediately to obtain the last error and the additional message which describes the parameter and the error pointer to the additional message field During the ge_GetConfigData function call once an error occurs Global Call stops retrieving the remaining parameters and returns an error value to the application If this function call is retrieving multiple parameters the parameters before the error may have been retrieved while other parameters will not have had a chance to be retrieved gc_GetConfigData E1 T1 and ISDN technologies only A
183. that may be provided in association with this document Except as permitted by such license no part of this document may be reproduced stored in a retrieval system or transmitted in any form or by any means without the express written consent of Intel Corporation Copyright 1996 2005 Intel Corporation Dialogic Intel Intel logo and Intel NetStructure are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries Other names and brands may be claimed as the property of others Publication Date August 2006 Document Number 05 2409 003 Intel 1515 Route 10 Parsippany NJ 07054 For Technical Support visit the Intel Telecom Support Resources website at http developer intel com design telecom support For Products and Services Information visit the Intel Telecom and Compute Products website at http www intel com design network products telecom For Sales Offices and other contact information visit the Buy Telecom Products page at http www intel com buy networking telecom htm Global Call API for HMP on Windows Programming Guide August 2006 intel Contents Revision History lt o 2 056 bene ek Re eee eee hea ee ge ee ale EAREN 11 About This Publication c2 scans sega rier testis eead eke eee eae Fhe G RS 13 PUNPOSE s ac euN ales ed Pew eae he ee ee a Seay ed ae Saeed aaa se Ed ed 13 Applicability atccecetaa tea ceteedes aawer bades SREE weg eee
184. the transmission of numerical and other information relating to the called and calling subscribers lines receive Accepting or taking digitized information transmitted by another device result value Describes the reason for an event RFU Reserved for future use SCbus Signal Computing bus Third generation TDM Time Division Multiplexed resource sharing bus that allows information to be transmitted and received among resources over multiple data lines A hardwired connection between Switch Handlers on SCbus based products for transmitting information over 1024 time slots to all devices connected to the SCbus SCSA Signal Computing System Architecture An open hardware and software standard architecture that incorporates virtually every other standard in PC based switching SCSA describes the components and specifies the interfaces for a signal processing system SCSA describes all elements of the system architecture from the electrical characteristics of the SCbus and SCxbus to the high level device programming interfaces All signaling is out of band In addition SCSA offers time slot bundling and allows for scalability SDP Site Dependent Parameter file used by the PDKRT Protocol configuration parameters that are user modifible for a specific installation site SIT See Special Information Tone Special Information Tone SIT Detection of an SIT sequence indicates an operator intercept or other problem in completing a call SRL
185. the call was received but not yet answered This provides an interval during which the system can verify parameters determine routing and perform other tasks before connecting the call A GCEV_ACCEPT event is generated when the ge_AcceptCall function is successfully completed and the call changes to the Accepted state The application can then answer the call by issuing the ge_AnswerCall function Call Establishment When the call is to be directly connected such as to a voice messaging system or if the application or thread is ready to answer the call a ge_AnswerCall function is issued to make the final connection Upon answering the call a GCEV_ANSWERED event is generated and the call changes to the Connected state At this point the call is connected to the called party and call charges begin Overlap Receiving This functionality applies to E1 T1 and ISDN technologies only After an incoming call has been received the call is offered to the application based on the call acknowledgement configuration and the availability of information required for proceeding with the call If the incoming call is in en bloc mode where all the information required for processing the call is present the call is offered to the application Otherwise the call is offered to the application based on the following configurations Call Acknowledgement If the application is configured to send the call acknowledgement the call is immediately offere
186. tion The GCEV_DETECTED event is generated if enabled If the GCEV_DETECTED event is generated a new CRN is assigned to the incoming call This event is for informational purposes to reduce glare conditions as the application is now aware of the presence of a call on the channel When developing applications if the GCEV_DETECTED event is not supported a GCEV_DISCONNECTED event is only received if the host application already received the GCEV_OFFERED event before the remote side disconnects Call Offered When an incoming call is received in en bloc mode where all the information required is available the call is offered to the application by generating an unsolicited GCEV_OFFERED event equivalent to a ring detected notification This GCEV_OFFERED event causes the call to change to the Offered state In the Offered state a CRN is assigned as a means of identifying the call on a specific line device If a GCEV_DETECTED event was generated before the GCEV_OFFERED event the same CRN is assigned as the one assigned when the GCEV_DETECTED event was generated When using E1 T1 and ISDN technology if the incoming call does not have sufficient information the call is offered to the application when all the required information is received If the technology is configured to accept minimum information the call is offered to the application when the specified minimum amount of information is received In this case the application must requ
187. tion is detected Non blocking alarms are alarms that do not cause the application to become blocked and do not generate a GCEV_BLOCKED or GCEV_UNBLOCKED event when the alarm is set or clears The ge_SetAlarmConfiguration function can be used to change which alarms are blocking and which alarms are not blocking for a given alarm source object To retrieve the status of the current alarm configuration use ge_GetAlarmConfiguration For more on changing the configuration of alarm source objects see Section 8 2 3 Configuration of Alarm Properties and Characteristics on page 101 The GCEV_BLOCKED and GCEV_UNBLOCKED events are unsolicited events that are sent in addition to other Global Call events The blocked and unblocked events do not require any application initiated action The blocked event is generated only for the first blocking condition detected Subsequent blocking conditions on the same line device will not generate additional blocked events Until all blocking conditions are cleared the line device affected by the blocking condition that is the line device that received the GCEV_BLOCKED event cannot generate or accept calls When the line device has completely recovered from the blocking condition a GCEV_UNBLOCKED event is sent When a blocking condition occurs while a call is in progress or connected any calls on the line device that is in the blocked condition are treated in the same manner as if a remote disconnection
188. tion is required a gce_CallAck GCACK_SERVICE_INFO function must be issued Since an acknowledgement was already sent out nothing is sent to the remote side at this time However if the minimum amount of information is not specified then the technology control layer requests and collects more information After all the maximum amount of information expected is received the technology control layer sends a call proceeding indication to the remote side The call is then offered to the application which can then accept or answer the call Scenario 3 In this scenario the technology call control layer is configured to acknowledge the incoming call and the application is configured to send a call proceeding indication after sufficient information has been received When an incoming call is detected the technology call control layer immediately sends an acknowledgement If the minimum amount of information required is specified then the call is offered to the application only after the minimum amount of information required is received Otherwise the call is immediately offered to the application When the call is in the Offered state after generation of the unsolicited GCEV_OFFERED event the application may selectively retrieve call information such as the Destination and Origination Global Call API for HMP on Windows Programming Guide August 2006 45 Call State Models i ntel 3 4 1 9 46 address caller ID by issuing the ge_Get
189. tion parameters and values in this context are target_type GCTGT_CCLIB_CHAN target_id the line device target_datap a pointer to a GC_PARM_BLLK structure that contains the following parameter set ID and parameter IDs e SetId CCSET_CALLANALYSIS e ParmId CCPARM_CA_MODE that can take any of the values described in Section 7 2 3 Configuring Call Progress Analysis on a Per Call Basis on page 88 In earlier releases when using CAS PDK protocols it was possible to specify call progress and call analysis on a per channel basis using the ge_SetParm function to enable or disable the Global Call API for HMP on Windows Programming Guide August 2006 91 Call Control Table 12 7 2 6 7 2 7 92 Note intel GCPR_CALLPROGRESS and GCPR_MEDIADETECT parameters See the Global Call E1 T1 CAS R2 Technology User s Guide for more information Table 12 shows how the CCPARM_CA_MODE values correspond to the GCPR_CALLPROGRESS and GCPR_MEDIADETECT parameters This table is provided as a convenience for users that have previously used the ge_SetParm method and now wish to use the greater flexibility provided by ge_MakeCall with the CCPARM_CA_MODE parameter Comparison with Call Progress Analysis Using gc_SetParm GCPR_CALLPROGRESS GCPR_MEDIADETECT Equivalent CCPARM_CA_MODE Value GCPV_DISABLE GCPV_DISABLE GC_CA_DISABLE GCPV_DISABLE GCPV_ENABLE GC_CA_POSTONLY_PVD_PAMD GCPV_ENABLE GCPV_DISABLE GC_CA
190. tions on the line device such as waiting for a call or making a call The application must wait for the GCEV_UNBLOCKED event before waiting for a call or making a call Since by default the line device is initially in the blocked condition the application does not receive an initial GCEV_BLOCKED event Circumstances can occur such as a blocking layer 1 physical alarm or the remote side going out of service that cause a line device to move to a blocked condition When this happens the application receives a GCEV_BLOCKED event When the line device is in the blocked condition the application can only perform a small subset of the valid functions for line devices The functions common to all interface technologies and that can be used while a line device is in the blocked condition are e gc DropCall e gc _ReleaseCall applies to E1 T1 and ISDN technologies only e gc_ReleaseCallEx e gc Close e Functions related to alarm processing and retrieving alarm information for example gc_AlarmName e Functions related to error processing for example gc_ErrorInfo e Functions related to event processing for example gc_ResultInfo gc_GetMetaevent and gc_GetMetaeventEx e Functions related to retrieving information about the call control libraries for example gc_CCLibIDToName gc_AttachResource and gc_Detach As indicated in the list above the application may drop and release calls while a line device
191. tus of the configurations These functions are e gc _GetAlarmConfiguration e gc_GetAlarmFlow e gc GetAlarmParm The use of these functions is described in the following sections Alarm configuration tips are also provided For more information about the alarm configuration functions see the Global Call API Library Reference For line devices opened by technologies that use GCAMS there is an entity called the network ASO ID that is the alarm source object associated with the network As a programming convenience Global Call defines ALARM_SOURCE_ID_NETWORK_ID that corresponds to the Global Call API for HMP on Windows Programming Guide August 2006 101 Alarm Handling i ntel 8 2 3 1 8 2 3 2 Note 8 2 3 3 8 2 3 4 102 network ASO ID This define is useful in many contexts For example notification of all alarms on a line device can be configured using the call gc_SetAlarmNotifyAll ALARM SOURCE_ID_NETWORK_ID The ALARM_SOURCE_ID_NETWORK_ID is a value that can be used to represent for a given line device whatever the network ASO ID happens to be Configuring Alarm Notification In order for an alarm to be sent to the application the notify attribute of the alarm must be set to yes Initially the notify attribute of all alarms is set to no The ge_SetAlarmConfiguration function is used to set and change the notify attribute for a specified alarm source object on a given
192. uide August 2006 Table 11 Call Control GC_CA_PREONLY_SIT Busy Ringing and SIT enabled GC_CA_POSTONLY_PVD Fax and PVD enabled GC_CA_POSTONLY_PVD_PAMD Fax PVD and PAMD enabled GC_CA_ENABLE_PVD Busy Ringing and SIT enabled fax and PVD enabled GC_CA_ENABLE_ ALL Busy Ringing and SIT enabled fax PVD and PAMD enabled These options correspond closely to call progress and call analysis options available when using the Voice API as indicated in Table 11 See the Call Progress Analysis chapter in the Voice API Programming Guide Call Progress Analysis Settings and Possible Results CCPARM_CA_MODE Setting Equivalent Pe a Structure GC_CA_DISABLE DISABLE GC_CA_PREONLY DX_OPTDIS GC_CA_PREONLY_SIT DX_OPTNOCON or DX_OPTEN GC_CA_POSTONLY_PVD DX_PVDENABLE GC_CA_POSTONLY_PVD_PAMD DX_PAMDENABLE GC_CA_ENABLE_PVD DX_PVDOPTNOCON or DX_PVDOPTEN GC_CA_ENABLE_ALL DX_PAMDOPTEN When an option that enables call progress is selected a GCEV_DISCONNECTED event can be received The ge_ResultInfo function can be used to get more information about the event The possible cause values the gc Value field in the associated GC_INFO structure that can be retrieved are GCRV_BUSY Busy GCRV_NOANSWER No Answer GCRV_CEPT SIT Operator Intercept GCRV_UNALLOCATED SIT Vacant Circuit non registered number GCRV_CONGESTION SIT No Circuit Found or SIT Reorder system busy Global Call API f
193. uide for more information Global Call API for HMP on Windows Programming Guide August 2006 7 4 7 4 1 Call Control Resource Routing The Global Call routing functions use the device handles of resources such as a voice channel a media resource or a network time slot The ge_GetResourceH function can be used to obtain the network media and voice device handles associated with the specified line device The gc_GetResourceH function with a resourcetype of GC_MEDIADEVICE returns the media device handle for the specified line device The gc_GetResourceH function with a resourcetype of GC_NETWORKDEVICE returns the network device handle for the specified line device The gc_GetResourceH function with a resourcetype of GC_VOICEDEVICE returns the voice device handle only if the specified line device has a voice media or tone resource associated with it for example if a voice channel was specified in the gec_OpenEx function devicename parameter or if the voice channel was subsequently attached to the line device and has remained attached to that line device Refer to the appropriate Global Call Technology Guide for technology specific information on routing resources when using the gec_OpenEx function to specify a voice or media resource or when using the gc_AttachResource function to associate a voice or media resource with a Global Call line device Feature Transparency and Extension Global Call Feat
194. ure Transparency and Extension FTE provides a common interface to multiple network interface specific libraries for features that are abstracted across multiple call control libraries see Figure 1 Global Call Architecture for IP Technology on page 20 and Figure 2 Global Call Architecture for E1 T1 and ISDN Technologies on page 21 FTE is described in the following topics e Feature Transparency and Extension Overview e Technology Specific Feature Access e Technology Specific User Information Feature Transparency and Extension Overview FTE is comprised of a number of Global Call functions These functions provide the flexibility to extend the generic Global Call API to access all technology or protocol specific features unique to any given network interfaces that were formerly only accessible via their native technology call control libraries Thus all technology specific features may be accessible from the application solely via the singular Global Call library interface thereby alleviating the need to access these call control libraries directly via additional APIs Global Call API for HMP on Windows Programming Guide August 2006 93 Call Control ntel m The Global Call API functions provided for FTE are gc_Extension provides a generic interface extensible for technology specific features gc_GetUserInfo for E1 T1 and ISDN technologies only retrieves technology specific user information for the specified
195. ve or change the default configuration of a GCLib even before any line device is opened Figure 27 shows the procedure for synchronous mode Figure 27 Getting or Setting GCLib Configuration in Synchronous Mode ere GlobalCall ge_Start Load GCLib gc_util_insert_parm_ref or Create Target Data for Retrieving gc_util_insert_parm_val or Updating GCLib Parameters gc_GetConfigData or Get the Current Values or Set New gc_SetConfigData Values of the GCLib Parameters gc_util_next_parm Get the Parameters from the Target Data Block for the gc_GetConfigData Function _________ The following describes the procedure for getting or setting the configuration of the GCLib in synchronous mode 1 Load the GCLib after the ge_Start function is called 2 Create the target object data a GC_PARM_BLK data structure with the appropriate set ID parm ID value size and value if applicable by calling the Global Call utility functions gc_util_insert_parm_ref or gc_util_insert_parm_val See the Global Call API Library Reference for more information 3 Call the ge_GetConfigData or gec_SetConfigData function with target_type GCTGT_GCLIB_SYSTEM target_id 0 time_out 0 mode EV_SYNC Global Call API for HMP on Windows Programming Guide August 2006 119 Lal Real Time Configuration Management ntel 4 If the ge_GetConfigData function returns successfully then obtain the individual paramet
196. vent only for the first alarm on condition for the line device When the Global Call API recognizes a blocking alarm off condition at the channel level a GCEV_UNBLOCKED event is generated for the time slot assuming there are no other blocking conditions on the line device The application will receive a GCEV_UNBLOCKED event only for the last alarm off condition for the line device When using Global Call with Intel NetStructure Digital Network Interface boards alarms apply only a the trunk level An alarm that occurs on a trunk applies to all channels on that trunk Generation of Alarm Events The GCEV_ALARM event can be generated by both blocking and non blocking alarms Blocking alarms are alarms that generate GCEV_BLOCKED and GCEV_UNBLOCKED events when the alarms set and clear GCEV_ALARM events are for information purposes only and do not cause any channel state or call state changes In order for the GCEV_ALARM event to be returned by the application the notify attribute for the specified alarm source object must be set to on via the ge_SetAlarmConfiguration function Global Call API for HMP on Windows Programming Guide August 2006 8 2 3 Alarm Handling In addition the alarm source object must meet the alarm flow configuration requirements which are set using the gc_SetAlarmFlow function or the ge_NotifyAll function See Section 8 2 3 Configuration of Alarm Properties and Characteristics on page 101
197. vice the application enabled event handlers This SRL handler thread exists as long as one handler is still enabled The creation of this internal SRL event handler thread is controlled by the SR_MODELTYPE value of the SRL sr_setparm function The SRL handler thread should be e enabled when using the asynchronous with SRL callback model Enable the SRL event handler thread by not specifying the SR_ MODELTYPE value default is to enable or by setting this value to SR_MTASYNC do not specify SR_STASYNC Global Call API for HMP on Windows Programming Guide August 2006 ntel Event Handling e disabled when using an application handler thread wherein a separate event handler thread is created within the application that calls the sr_waitevt and gec_GetMetaEvent functions For an application handler model use the asynchronous with SRL callback model but set the SR_MODELTYPE value to SR_STASYNC to disable the creation of the internal SRL event handler thread Note An application handler thread must not call any synchronous functions See the Standard Runtime Library API Programming Guide for the hierarchy priority order in which event handlers are called Global Call API for HMP on Windows Programming Guide August 2006 75 Event Handling 76 Global Call API for HMP on Windows Programming Guide August 2006 intel Application Development 5 Guidelines This chapter provides some tips when developing programs usi
198. voice boards in the system respectively In Linux use SRL device mapper functions to return information about the structure of the system For information on these functions see the Standard Runtime Library API Library Reference 1 Start Initialize Global Call using ge_Start 2 Use ge_OpenEx to open a Global Call line device e Specify the network interface device name and the protocol name in the devicename parameter as in the following example N dtiBlT1 P ISDN e Alternatively specify the network interface device name the voice device name and the protocol name in the devicename parameter as in the following example N dtiBlT1 V_dxxxB1C1 P_ ar r2_ io Obtain the voice channel device handle e Open a voice channel device for example dxxxB1C1 with dx_open to get its handle e Alternatively if you specified the voice device name in the devicename parameter in step 2 use gc_GetResourceH with a resourcetype of GC_VOICEDEVICE to get the handle Attach the voice and network interface devices e Use gc_AttachResource to attach the voice resource and the network interface line device e Alternatively if you specified the voice device name in the devicename parameter in step 2 the voice and network interface devices are attached by nature of the gc_OpenEx so no action is necessary for this step Use ge_GetResourceH with a resourcetype of GC_NETWORKDEVICE to obtain the network in
199. wing values of type GC_VALUE_LONG or an ORed combination of the values e GCMSK_ALERTING_STATE e GCMSK_CALLROUTING_STATE for E1 T1 and ISDN technologies only e GCMSK_DETECTED_STATE e GCMSK_GETMOREINFO_ STATE for E1 T1 and ISDN technologies only e GCMSK_PROCEEDING_STATE e GCMSK_SENDMOREINFO_STATE for E1 T1 and ISDN technologies only See the Global Call API Library Reference for more information on the gc_SetConfigData function Call State Event Configuration Some call state transition events can be masked so that the events are not generated Although an event may be masked the corresponding call state transition can still take place This configuration can be done by issuing the gec_SetConfigData function with a target_type of GCTGT_GCLIB_CHAN and a target_ID of a line device and passing the appropriate set ID and parm IDs The set ID used in this context is GCSET_CALLEVENT_MSK and the relevant parm IDs are GCACT_ADDMSK Enable the notification of events specified in the value in addition to previously enabled events GCACT_SUBMSK Disable notification of the events specified in the value GCACT_SETMSK Enable the notification of events specified in the value and disables notification of any event not specified The GCACT_ADDMSK GCACT_SUBMSK and GCACT_SETMSK parm IDs can be assigned one of the following values of type GC_VALUE_LONG or an ORed combination of the values e GCMSK_ALERTING e GCMSK_DETEC
200. ws Programming Guide August 2006 139 Lal Building Applications ntel 5 12 1 3 Note 12 1 4 140 Variables for Compiling and Linking Commands The following variables provide a standardized way of referencing the directories that contain header files and shared objects INTEL_DIALOGIC_INC Variable that points to the directory where header files are stored INTEL_DIALOGIC_LIB Variable that points to the directory where shared library files are stored These variables are automatically set at login and should be used in compiling and linking commands The following is an example of a compiling and linking command that uses these variables cc IS INTEL DIALOGIC_INC o myapp myapp c LS INTEL DIALOGIC LIB lgc It is strongly recommended that developers use these variables when compiling and linking applications The names of the variables will remain constant but the values may change over time Dynamically Loaded Libraries When the ge_Start function is called the configured library or libraries that are used by the application are dynamically loaded The libraries include libdm3cc dll for E1 T1 and ISDN technologies DM3 call control library libgch3r dll IP call control library libgcipm dll IP call control library If a configured library cannot be found the Global Call API enters an error message in the event logger Global Call API for HMP on Windows Programming Guide August 2006 int
201. y to whom the call is being transferred before the transfer is completed Unsupervised transfers the call is sent without any consultation or announcement by the person transferring the call Unsupervised transfers are also known as one step transfers or blind transfers The the call transfer implementations described in this section are common to a number of different technologies However not all technologies support these implementations and some technologies have technology specific implementations for call transfer See the appropriate Global Call Technology Guide for technology specific information on call transfer Global Call API for HMP on Windows Programming Guide August 2006 3 5 4 2 Note Call State Models Supervised transfers use the following Global Call API functions gc_SetupTransfer initiates a supervised transfer gc_CompleteTransfer completes a supervised transfer gc_SwapHold switches between the consultation call and the call pending transfer Unsupervised transfers use the following Global Call API function gc_BlindTransfer initiates and completes an unsupervised one step transfer Supervised Transfers A supervised transfer begins with a successful call to the ge_SetupTransfer function The following steps describe how the transfer is completed 1 Successful call to the ge_SetupTransfer function changes the state of the original call to the GCST_ONHOLDPENDINGTRANSEER state 2
202. yes 39 e Advanced Call Control with Call Hold and Transfer 000005 64 3 1 Call State Model Overview Global Call maintains a generic call model from which technology specific call models can be derived Some technologies support only a subset of the complete call model The call establishment and termination procedures are based on this call model The following sections describe the call states associated with the basic call model and configuration options 3 2 Basic Call Model Each call received or generated by Global Call is processed through a series of states where each state represents the completion of certain tasks or the current status of the call Some states in the basic call model are optional and can be enabled or disabled selectively Only the optional states can be enabled or disabled Every technology or call control library has a default call state model consisting of all the states it can possibly support from the basic call model If a state is disabled all corresponding events are disabled If a state is enabled all corresponding events are enabled The call states change in accordance with the sequence of functions called by the application and the events that originate in the network and system hardware The current state of a call can be changed by e Function call returns e Termination events indications of function completion e Unsolicited events The states of the basic call model are describe
203. you won t experience problems This change is not necessary for all applications but if you experience poor initialization performance you can gain back speed by using this hint Using Protocols Flexible Routing For ISDN protocols the protocol to use is determined at board initialization time and not when opening a Global Call device Protocol parameters are configured in the CONFIG file before the firmware is downloaded to the board If a protocol is specified in the devicename parameter of the gc_OpenEx function when opening a device it is ignored For T1 E1 CAS R2MF protocols the protocol to use for a trunk is selected using the Trunk Configurator feature of the configuration manager DCM Protocol files are provided with the system software in the data directory under the Dialogic home directory A protocol can be configured by changing the parameter values in the corresponding Country Dependent Parameter CDP file located in the data directory See the Global Call Country Dependent Parameters CDP for PDK Protocols Configuration Guide for details on the parameters that can be changed for each protocol If a protocol is specified in the devicename parameter of the gc_OpenEx function when opening a device it is ignored Handling Multiple Call Objects Per Channel in a Glare Condition When using Digital Network Interface boards Global Call supports the handling of multiple call objects per channel in a glare conditio

Intel 05-2409-003 Digital Camera User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents