6.2 Target Objects
This section provides information related to the various target objects used by the Global Call API.
Table 19 shows the combinations of physical or logical entities and software module entities that can make up a target (target_type).
Table 19. Supported Target Types
|
|
|
|
|
|
|
|
|
GCLib
|
|
|
|
|
|
CCLib
|
|
|
|
|
|
Protocol
|
|
|
|
|
|
Firmware
|
|
|
|
|
S = Supported
SV
= Supported with variances; see appropriate Global Call Technology
User's Guide |
Table 20 shows the target types, as described in Table 19, with various target IDs to represent valid target objects.
Table 20. Target Type and Target ID Pairs
|
|
|
|
|
GCTGT_GCLIB_SYSTEM†
|
GCGV_LIB(0)
|
Global Call library module target object
|
|
GCTGT_CCLIB_SYSTEM†
|
CCLib ID
|
Call control library module target object
|
|
GCTGT_PROTOCOL_ SYSTEM†
|
Protocol ID
|
Protocol 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_PROTOCOL_ NETIF
|
Global Call Line device ID
|
Network Interface target object in Protocol module
|
|
GCTGT_FIRMWARE_ NETIF†
|
Global Call Line device ID
|
Network Interface target object in Firmware 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
|
|
GCTGT_PROTOCOL_ CHAN
|
Global Call Line device ID
|
Channel of protocol module target object
|
|
GCTGT_FIRMWARE_ CHAN
|
Global Call Line device ID
|
Channel target object in firmware module
|
|
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
|
| †Can only be used by functions issued in synchronous mode. |
Figure 2 gives the memory diagram for the GC_PARM_BLK structure.
Figure 2. GC_PARM_BLK Memory Diagram
Figure 3 is an example of the GC_PARM_BLK structure filled with some parameters for IP technology.
Figure 3. Sample GC_PARM_BLK Memory Diagram
Table 21 shows possible (set ID, parm ID) pairs for passing additional parameters in the GCLIB_MAKECALL_BLK structure. The Value column show the possible values for the parameter IDs.
Table 21. Possible Set ID, Parm ID Pairs used in GCLIB_MAKECALL_BLK Structure
|
|
|
|
|
GCSET_DEST_ADDR
|
GCPARM_ADDR_DATA
|
technology-specific format
|
|
GCPARM_ADDR_TYPE
|
GCADDRTYPE_TRANSPARENT
GCADDRTYPE_NAT
GCADDRTYPE_INTL
GCADDRTYPE_LOC
GCADDRTYPE_IP
GCADDRTYPE_URL
GCADDRTYPE_DOMAIN
GCADDRTYPE_EMAIL
|
|
GCPARM_ADDR_PLAN
|
GCADDRPLAN_UNKNOWN
GCADDRPLAN_ISDN
GCADDRPLAN_TELEPHONY
GCADDRPLAN_PRIVATE
|
|
GCPARM_SUBADDR_DATA
|
technology-specific format
|
|
GCPARM_SUBADDR_TYPE
|
GCSUBADDR_UNKNOWN
GCSUBADDR_OSI
GCSUBADDR_USER
GCSUBADDR_IA5
|
|
GCPARM_SUBADDR_PLAN
|
protocol specific
|
|
GCSET_ORIG_ADDR
|
GCPARM_ADDR_DATA
|
technology-specific format
|
|
GCPARM_ADDR_TYPE
|
GCADDRTYPE_TRANSPARENT
GCADDRTYPE_NAT
GCADDRTYPE_INTL
GCADDRTYPE_LOC
GCADDRTYPE_IP
GCADDRTYPE_URL
GCADDRTYPE_DOMAIN
GCADDRTYPE_EMAIL
|
|
GCPARM_ADDR_PLAN
|
GCADDRPLAN_UNKNOWN
GCADDRPLAN_ISDN
GCADDRPLAN_TELEPHONY
GCADDRPLAN_PRIVATE
|
|
GCPARM_SUBADDR_DATA
|
technology-specific format
|
|
GCPARM_SUBADDR_TYPE
|
GCSUBADDR_UNKNOWN
GCSUBADDR_OSI
GCSUBADDR_USER
GCSUBADDR_IA5
|
|
GCPARM_SUBADDR_PLAN
|
protocol specific
|
|
GCSET_CHAN_BLK
|
GCPARM_CHAN_MEDIA_ID
|
GC_DISABLE
GC_ENABLE
|
|
GCPARM_CHAN_MEDIA_SEL
|
GCMEDSEL_MEDIUM_PREF
GCMEDSEL_MEDIUM_EXCL
|
|
GCSET_CALL_BLK
|
GCPARM_CALL_CATEGORY
|
GCCAT_SUB_NOPRIOR
GCCAT_SUB_PRIOR
GCCAT_MAINT_EQUIP
GCCAT_COIN_BOX
GCCAT_OPERATOR
GCCAT_DATA
GCCAT_CPTP
GCCAT_SPECIAL
GCCAT_MOBILE
GCCAT_VPN
|
|
GCPARM_CALL_ADDR_INFO
|
GCADDRINFO_ENBLOC
GCADDRINFO_OVERLAP
|
| † More set IDs, parameter IDs, and parameter values can be specified by the call control library. |
The parameter lists for the gc_SetConfigData( ) and gc_GetConfigData( ) functions are shown in Table 22 and Table 23.
Table 22. GC Parameter Entry List Maintained in GCLIB
|
|
|
|
|
|
|
|
GCSET_ DEVICEINFO
|
GCPARM_ DEVICENAME
|
GCTGT_ GCLIB_NETIF
GCTGT_ GCLIB_CHAN
|
Device name
|
string
|
GC_R_O
|
|
GCSET_ DEVICEINFO
|
GCPARM_ NETWORKH
|
GCTGT_ GCLIB_NETIF
GCTGT_ GCLIB_CHAN
|
Network device handle
|
int
|
GC_R_O
|
|
GCSET_ DEVICEINFO
|
GCPARM_ VOICENAME
|
GCTGT_ GCLIB_CHAN
|
Voice device name
|
string
|
GC_R_O
|
|
GCSET_ DEVICEINFO
|
GCPARM_ VOICEH
|
GCTGT_ GCLIB_CHAN
|
Voice device handle
|
int
|
GC_R_O
|
|
GCSET_ CALLEVENT_MSK
|
GCPARM_ GET_MSK
|
GCTGT_ GCLIB_CHAN
|
Get call event mask
|
long
|
GC_R_O
|
|
GCSET_ CALLEVENT_MSK
|
GCACT_ SETMSK
|
GCTGT_ GCLIB_CHAN
|
Set call event mask
|
long
|
GC_W_N
|
|
GCSET_ CALLEVENT_MSK
|
GCACT_ ADDMSK
|
GCTGT_ GCLIB_CHAN
|
Add call event mask
|
long
|
GC_W_N
|
|
GCSET_ CALLEVENT_MSK
|
GCACT_ SUBMSK
|
GCTGT_ GCLIB_CHAN
|
Sub call event mask
|
long
|
GC_W_N
|
|
GCSET_ CALLSTATE_MSK
|
GCPARM_ GET_MSK
|
GCTGT_ GCLIB_CHAN
|
Get call state mask
|
long
|
GC_R_O
|
|
GCSET_ CALLSTATE_MSK
|
GCACT_ SETMSK
|
GCTGT_ GCLIB_CHAN
|
Set call state mask
|
long
|
GC_W_N
|
|
GCSET_ CALLSTATE_MSK
|
GCACT_ ADDMSK
|
GCTGT_ GCLIB_CHAN
|
Add call state mask
|
long
|
GC_W_N
|
|
GCSET_ CALLSTATE_MSK
|
GCACT_ SUBMSK
|
GCTGT_ GCLIB_CHAN
|
Sub call state mask
|
long
|
GC_W_N
|
|
GCSET_CRN_ INDEX
|
GCPARM_ 1ST_CRN
|
GCTGT_ GCLIB_CHAN
|
1st CRN
|
long
|
GC_R_O
|
|
GCSET_CRN_ INDEX
|
GCPARM_ 2ND_CRN
|
GCTGT_ GCLIB_CHAN
|
2nd CRN
|
long
|
GC_R_O
|
|
GCSET_ DEVICEINFO
|
GCPARM_ CALLSTATE
|
GCTGT_ GCLIB_CRN
|
Call state
|
int
|
GC_R_O
|
|
GCSET_ DEVICEINFO
|
GCPARM_ BOARD_LDID
|
GCTGT_ GCLIB_NETIF
GCTGT_ GCLIB_CHAN
|
Network interface board ID
|
long
|
GC_R_O
|
|
GCSET_ PROTOCOL
|
GCPARM_ PROTOCOL_ID
|
GCTGT_ GCLIB_NETIF
GCTGT_ GCLIB_CHAN
|
Protocol ID
|
long
|
GC_R_O
|
|
GCSET_ PROTOCOL
|
GCPARM_ PROTOCOL_ NAME
|
GCTGT_ GCLIB_NETIF
GCTGT_ GCLIB_CHAN
|
Protocol Name
|
string
|
GC_R_O
|
|
GCSET_ CCLIB_INFO
|
GCPARM_ CCLIB_ID
|
GCTGT_ GCLIB_NETIF
GCTGT_ GCLIB_CHAN
GCTGT_ PROTOCOL_ SYSTEM
|
CClib ID
|
long
|
GC_R_O
|
|
GCSET_ CCLIB_INFO
|
GCPARM_ CCLIB_NAME
|
GCTGT_ GCLIB_NETIF
GCTGT_ GCLIB_CHAN
GCTGT_ PROTOCOL_ SYSTEM
|
CClib ID
|
string
|
GC_R_O
|
† Possible values
are:
GC_R_O
- Retrieve only
GC_W_I
- Update immediately
GC_W_N
- Update only while call is in the Null state
GC_W_X
- Not available |
Table 23. Examples of Parameter Entry List Maintained in CCLIB
|
|
|
|
|
|
|
|
GCSET_ CALLINFO
|
CALLINFOTYPE
|
GCTGT_ CCLIB_CRN
|
Calling info type
|
string
|
GC_R_O
|
|
GCSET_ CALLINFO
|
CATEGORY_ DIGIT
|
GCTGT_ CCLIB_CRN
|
Category digit
|
char
|
GC_R_O
|
|
GCSET_ CALLINFO
|
CONNECT_ TYPE
|
GCTGT_ CCLIB_CRN
|
Connect type
|
char
|
GC_R_O
|
|
GCSET_PARM
|
GCPR_ CALLINGPARTY
|
GCTGT_ GCLIB_CHAN
|
Calling party
|
string
|
GC_W_I
|
|
GCSET_PARM
|
GCPR_ LOADTONES
|
GCTGT_ GCLIB_CHAN
|
Load tones
|
short
|
GC_W_I
|
|
GCSET_ ORIG_ADDR
|
GCPARM_ ADDR_DATA
|
GCTGT_ GCLIB_CHAN
|
Calling number
|
string
|
GC_W_I
|
† Possible values
are:
GC_R_O
- Retrieve only
GC_W_I
- Update immediately
GC_W_N
- Update only while call is in the Null state
GC_W_X
- Not available |
- Note: The parameter entries shown in Table 23 are examples only. The configurable parameters depend on the CCLib implementation.