This chapter describes the API functions and structures that an external application must use to exchange messages with the Cisco IOS Gatekeeper, and contains the following sections:
The external application links with the object code, which contains the API functions. The header file contains API prototypes and type definitions.
Gatekeeper API Functions
This section describes the functions provided with the API. These functions should be used by the external application to gather information from and provide information to the Cisco IOS Gatekeeper. The functions described in this section are:
This function sets up the socket for the application to communicate as a client with the Cisco IOS Gatekeeper. In this situation, the application is the client and the Gatekeeper is the server, which means the application must initiate the communication with the Cisco IOS Gatekeeper.
Input
The input to this function is:
A pointer to the GKAPI_SOCK_INFO structure. The application must set up the TCPPort and IPAddress fields and must preserve this structure for the duration of the connection.
A pointer to the STATUS_TYPE enumeration. Possible values for STATUS_TYPE are:
PROCESSING_SUCCESSFUL—Successful connection to the Cisco IOS Gatekeeper.
CONNECT_IN_PROGRESS—Connection is pending.
TCP_HANDLE_ERROR—Error was encountered in handle creation.
TCP_CONNECT_ERROR—Error was encountered in connecting to the Cisco IOS Gatekeeper.
TCP_NONBLOCK_ERROR—Error was encountered when setting up the socket for nonblocking I/O
A boolean value that allows the application to specify if the socket I/O should be nonblocking or blocking. If the application specifies blocking, the Gatekeeper API calls to setup the connection and read a message that does not return until the action is complete.
Return
The return for this function is an integer. If the client socket connection has been set up successfully or is in progress, a connection handle is returned. This connection handle is the socket descriptor that the application uses to wait on a connection completion or read socket event. If an error occurs while setting up the client connection, the value -1 is returned. In this case, the error information is provided in the STATUS_TYPE.
GkapiSetupServer
This function sets up the socket for the application to communicate as a server with the Cisco IOS Gatekeeper. In this situation, the application is the server and the Gatekeeper is the client, which means that the application will accept incoming connections from Cisco IOS Gatekeeper clients.
Input
A pointer to the GKAPI_SOCK_INFO structure. The application must set up the TCPPort and IPAddress fields and must preserve this structure for the duration of the connection.
A pointer to the STATUS_TYPE enumeration. Possible values for STATUS_TYPE are:
PROCESSING_SUCCESSFUL—Successful connection to the Cisco IOS Gatekeeper.
TCP_HANDLE_ERROR—Error was encountered in handle creation.
TCP_ADDRESS_ALREADY_IN_USE—Specified local IP address is already in use.
TCP_ADDRESS_NOT_AVAIL—Specified local IP address is not available on the local machine.
TCP_BIND_ERROR—Error was encountered in setting up the server socket.
TCP_LISTEN_ERROR—Error was encountered in setting up the server socket.
TCP_NONBLOCK_ERROR—Error was encountered when setting up the socket for nonblocking I/O.
A boolean value that allows the application to specify if the socket I/O should be nonblocking or blocking. If the application specifies blocking, the Gatekeeper API calls to setup the connection and read a message that does not return until the action is complete.
Return
The return for this function is an integer. If the client socket connection has been set up successfully or is in progress, a connection handle is returned. This connection handle is the socket descriptor that the application uses to wait on a connection completion or read socket event. If an error occurs while setting up the client connection, the value -1 is returned. In this case, the error information is provided in the STATUS_TYPE.
GkapiClientConnected
This function must be called by the application to indicate that a select event for a connect complete has occurred.
A pointer to the STATUS_TYPE enumeration. Possible values for STATUS_TYPE are:
PROCESSING_SUCCESSFUL—Successful connection to the Gatekeeper.
TCP_CONNECT_ERROR—Error was encountered in connecting to the Gatekeeper.
An integer that indicates that a connect complete has occurred.
Return
The return for this function is an integer. If the socket connection has been set up successfully or is in progress, a connection handle is returned. This connection handle is the socket descriptor that the application uses to wait on a connection completion or read socket event. If an error occurs while setting up the client connection, the value -1 is returned. In this case, the error information is provided in the STATUS_TYPE.
GkapiAcceptConnection
This function must be called by the application (when it is running in the server mode) to indicate that a select event for an incoming connection has occurred.
A pointer to the STATUS_TYPE enumeration. Possible values for STATUS_TYPE are:
PROCESSING_SUCCESSFUL—Successful connection to the Cisco IOS Gatekeeper.
TCP_CONNECT_ERROR—Error was encountered in connecting to the Cisco IOS Gatekeeper.
An integer that indicates that an incoming connection has occurred.
A pointer to the GKAPI_TCP_ADDR_INFO structure. The Gatekeeper API provides the IP address and TCP port of the client with which this connection is associated.
Return
The return for this function is an integer. If the socket connection has been set up successfully or is in progress, a connection handle is returned. This connection handle is the socket descriptor that the application uses to wait on a connection completion or read socket event. If an error occurs while setting up the client connection, the value -1 is returned. In this case, the error information is provided in the STATUS_TYPE.
GkapiGetVersion
Applications can use this function to obtain the GKTMP version used by the API and the gatekeeper. The version number consists of a major number (gk_major) and a minor number (gk_minor). For example, Version 1 is represented as 100.
The return for this function is an integer. The integer indicates one of the following status codes:
GKAPI_RET_OK—Gatekeeper TMP version is prior to or the same as the gatekeeper API version.
GKAPI_RET_NOK—Gatekeeper TMP version is later than the gatekeeper API version.
GKAPI_RET_OK_NOGKDATA—Version used by the gatekeeper is not known. In this case, the gk_major and gk_minor members of GKAPI_VERSION_INFO_T are invalid and set to -1.
CloseGateKeeperConnection
This function closes the TCP connection between the external application and the Cisco IOS Gatekeeper. This function is called under error circumstances and when the external application no longer wants to maintain a relationship with the Cisco IOS Gatekeeper.
Input
The input for this function is a pointer to the GKAPI_SOCK_INFO structure.
Return
There is no return for this function.
GetReadMsgBuffer
This function allocates memory for the size of GK_READ_MSG structure. This structure is used to store messages received from the Cisco IOS Gatekeeper. This function contains an enumeration of the messages that can be received (REQUEST messages from the Cisco IOS Gatekeeper for RRQ, ARQ, LRQ, LCF, LRJ, as well as registration and unregistration responses from the Cisco IOS Gatekeeper for ARQ, RRQ, URQ, LRQ, LCF, LRJ messages) and a union of structures for the different messages.
Note When the external application no longer needs the message buffer, the application must call
FreeReadMsgBuffer to release the memory back to the system.
Input
There is no input to this function.
Return
The return for this function is a pointer to the GK_READ_MSG structure. If the memory allocation fails, this pointer will be NULL.
ReadMsgBuffer
This function reads a message from the TCP socket and should be called when the external application has detected a read event on the socket. This function stores the message type into the structure. The parameters received in the message are stored in the structure that corresponds with the message type.
Note GetReadMsgBuffer must be called to allocate an empty buffer before this function can be used.
FreeReadMsgBuffer must be called after this function has completed, except when the STATUS_TYPE
returns INCOMPLETE_MSG_READ.
After reading a message, this function sets the message type and populates the appropriate structure. For example, if an ARQ message has been received from the Cisco IOS Gatekeeper, the msgType parameter is set to ARQ_REQUEST_MSG and the ARQ_REQUEST_MSG structure is populated.
Because some parameters are optional, these parameters might not be received for a particular message. Structure members that are character pointers are initialized to NULL. Integers and enumerations are set to their initialization values. Therefore, the API can assume that if a structure member has a pointer set to NULL or to its initialization value, that particular parameter has not been received.
The following initialization values indicate that the parameter was not received from the Cisco IOS Gatekeeper:
canMapAlias—INITIALIZE_CAN_MAP_ALIAS_VALUE
bandWidthPresent—TRUE (indicating that bandWidth has been received and filled in) or FALSE (indicating that bandWidth has not been received)
A pointer to the GK_READ_MSG structure that was allocated by the GetReadMsgBuffer function. The GK_READ_MSG structure contains an enumeration of the message types expected from the Cisco IOS Gatekeeper and a union of structures for various messages expected from the Cisco IOS Gatekeeper.
Return
The return for this function is the STATUS_TYPE. Possible values for STATUS_TYPE are:
PROCESSING_SUCCESSFUL—No errors were encountered.
TCP_READ_ERROR—A TCP read error was encountered. The application should call CloseGateKeeperConnection to close the connection to the Cisco IOS Gatekeeper.
MEM_ALLOC_FAIL—Memory allocation failed. This function, dynamically allocates memory for fields within the GK_READ_MSG structure.
MSG_READ_ERROR—The message read was not understood by the API function. The application should call CloseGateKeeperConnection to close the connection to the Cisco IOS Gatekeeper.
INCOMPLETE_MSG_READ—The message was not completely read from the TCP connection because of network conditions. The application should call the function again in order to continue reading the data. In this situation, FreeMsgBuffer should not be called. After all the data has been read, the STATUS_TYPE is set to one of the other possible values, and after processing the message type the FreeMsgBuffer can be called.
TCP_CONNECTION_CLOSED—The connection to the Cisco IOS Gatekeeper has been closed. The application must call CloseGateKeeperConnection to free resources such as gkHandle in the GKAPI_SOCK_INFO structure.
NULL_POINTER_PASSED—The pointer to the GK_READ_MSG is null.
FreeReadMsgBuffer
This function frees memory that was allocated by the call to GetReadMsgBuffer and ReadMsgBuffer. This function must be called after processing the information returned by ReadMsgBuffer.
Input
The input for this function is a pointer to the GK_READ_MSG structure.
Return
There is no return for this function.
WriteCommandMsg
This function sends a command message to the Cisco IOS Gatekeeper, which can respond with a result message. This structure, CMD_MSG_TYPE, contains an enumeration of messages that can be sent as spontaneous commands to the Cisco IOS Gatekeeper. The CMD_HEADER_INFO_TYPE structure must include the from, to, transaction-id, and notification-only fields.
A pointer to the GK_CMD_MSG_TYPE structure, which contains a union of the structures for the various command messages that can be sent to the Cisco IOS Gatekeeper. Each structure contains a header, CMD_HEADERINFO_TYPE, that must be filled in by the application. The msgType field must be filled in to indicate which command message should be sent to the Cisco IOS Gatekeeper.
Return
The return for this function is the STATUS_TYPE. Possible values for STATUS_TYPE are:
PROCESSING_SUCCESSFUL—No errors were encountered.
CONNECT_IN_PROGRESS—Connection is pending. The application should retry this API call after some time has passed.
TCP_WRITE_ERROR—A TCP write error was encountered. The application should call CloseGateKeeperConnection to close the connection to the Cisco IOS Gatekeeper.
MEM_ALLOC_FAIL—Memory allocation failed.
TCP_CONNECTION_CLOSED—The connection to the Cisco IOS Gatekeeper has been closed. The application must call CloseGateKeeperConnection to free resources such as gkHandle in the GKAPI_SOCK_INFO structure.
HEADER_INFO_INCOMPLETE—One of the fields in the header (To, From, TransactionID) is incomplete.
NULL_POINTER_PASSED—The pointer to the GK_CMD_MSG is null.
WriteResponseMsg
This function writes a response message to the Cisco IOS Gatekeeper. This structure contains RESPONSE_MSG_TYPE, which is an enumeration of the response messages that can be sent to the Cisco IOS Gatekeeper.
The calling function must set the message type and populate the appropriate structure within the union. For example, if a response RCF needs to be sent to the Cisco IOS Gatekeeper, the application should set the msgType to RCF_RESPONSE_MSG and populate the RCF_RESPONSE_MSG structure.
The following rules apply to responses sent by the external application to the Cisco IOS Gatekeeper:
Transport-addresses must be preceded with "I:", followed by the address.
Alias-addressesmust be preceded with either "H:", "E:", or "M:" followed by the alias address.
Values in a "sequence of values" must be separated by a space.
HEADER_INFO must include the "from", "to" and "transactionID" fields. The notification field is not used with the WriteResponseMsg function.
Only changed or new fields should be populated and sent to the Cisco IOS Gatekeeper. Parameters that are not to be sent to the Cisco IOS Gatekeeper must either be set to their initialization value or to NULL (for pointers). The API assumes that if a structure member is set to its initialization value or has a pointer set to NULL, that parameter should not be sent to the Cisco IOS Gatekeeper.
The following initialization values indicate that the parameter should not be sent to the Cisco IOS Gatekeeper:
bandWidthPresent—TRUE (indicating that the bandWidth should be sent) or FALSE (indicating that the bandWidth should not be sent)
Note If the application requires additional time before responding to a message from the
Cisco IOS Gatekeeper, the application can send a "delay" message by setting msgType to
RIP_RESPONSE_MSG. The delay value (1 through 65536) must be specified and the transactionID
must be the same as the one received from the Cisco IOS Gatekeeper.
A pointer to the IRR_REQUEST_MSG structure, which contains an enumeration of message types for which a response might be sent to the Cisco IOS Gatekeeper. The input also contains a union of structures for each message response.
Return
The return for this function is the STATUS_TYPE. Possible values for STATUS_TYPE are:
PROCESSING_SUCCESSFUL—No errors were encountered.
CONNECT_IN_PROGRESS—Connection is pending. The application should retry this API call after some time has passed.
TCP_WRITE_ERROR—A TCP write error was encountered. The application should call CloseGateKeeperConnection to close the connection to the Cisco IOS Gatekeeper.
MEM_ALLOC_FAIL—Memory allocation failed.
TCP_CONNECTION_CLOSED—The connection to the Cisco IOS Gatekeeper has been closed. The application must call CloseGateKeeperConnection to free resources such as gkHandle in the GKAPI_SOCK_INFO structure.
INVALID_MSG_SPECIFIED—The message type is not within the RESPONSE_MSG_TYPE range.
INVALID_ENDPOINT_SPECIFIED—The endpoint does not match one of the possible values for ENDPOINT_TYPE.
INVALID_REDIRECT_REASON_SPECIFIED—The redirect reason does not match one of the possible values for REDIRECT_REASON_TYPE.
INVALID_REJECT_REASON_SPECIFIED—The rejection reason does not match one of the possible values for REJECT_REASON_TYPE.
INVALID_DELAY_SPECIFIED—The delay is not within the valid range.
HEADER_INFO_INCOMPLETE—One of the fields in the header (To, From, TransactionID) is incomplete.
NULL_POINTER_PASSED—The pointer to GK_WRITE_MSG is null.
WriteRegisterMessage
This function sends a registration message to the Cisco IOS Gatekeeper and allows triggers to be dynamically registered with the Cisco IOS Gatekeeper. This structure, REGISTER_MSG_TYPE, contains an enumeration of messages that can be registered with the Cisco IOS Gatekeeper.
The REGISTER_REQUEST_HEADER structure must include the "from," "to," "priority," and "notification-only" fields.
A pointer to the GK_REGISTER_MSG structure, which contains a union of the structures for the various registration messages that can be sent to the Cisco IOS Gatekeeper. Each structure contains a header, REGISTER_REQUEST_HEADER, that must be filled in by the application. The msgType field must be filled in to indicate which registration message should be sent to the Cisco IOS Gatekeeper.
Return
The return for this function is the STATUS_TYPE. Possible values for STATUS_TYPE are:
PROCESSING_SUCCESSFUL—No errors were encountered.
CONNECT_IN_PROGRESS—Connection is pending. The application should retry this API call after some time has passed.
TCP_WRITE_ERROR—A TCP write error was encountered. The application should call CloseGateKeeperConnection to close the connection to the Cisco IOS Gatekeeper.
MEM_ALLOC_FAIL—Memory allocation failed.
TCP_CONNECTION_CLOSED—The connection to the Cisco IOS Gatekeeper has been closed. The application must call CloseGateKeeperConnection to free resources such as gkHandle in the GKAPI_SOCK_INFO structure.
INVALID_MSG_SPECIFIED—The message type is not within the RESPONSE_MSG_TYPE range.
INVALID_ENDPOINT_SPECIFIED—The endpoint does not match one of the possible values for ENDPOINT_TYPE.
INVALID_REDIRECT_REASON_SPECIFIED—The redirect reason does not match one of the possible values for REDIRECT_REASON_TYPE.
HEADER_INFO_INCOMPLETE—One of the fields in the header (To, From, TransactionID) is incomplete.
NULL_POINTER_PASSED—The pointer to the GK_REGISTER_MSG is null.
The following initialization values indicate that the parameter should not be sent to the Cisco IOS Gatekeeper for Registration, and the external application is not interested in these parameters:
This function sends an unregister message to the Cisco IOS Gatekeeper when the application no longer wants to receive a particular message. This structure contains REGISTER_MSG_TYPE, which is an enumeration of messages that can be unregistered with the Cisco IOS Gatekeeper.
A pointer to the GK_UNREGISTER_MSG structure, which contains the To, From, and Priority fields that must be filled in by the application. The msgType must be filled in to indicate which message needs to be unregistered.
Return
The return for this function is the STATUS_TYPE. Possible values for STATUS_TYPE are:
PROCESSING_SUCCESSFUL—No errors were encountered.
CONNECT_IN_PROGRESS—Connection is pending. The application should retry this API call after some time has passed.
TCP_WRITE_ERROR—A TCP write error was encountered. The application should call CloseGateKeeperConnection to close the connection to the Cisco IOS Gatekeeper.
MEM_ALLOC_FAIL—Memory allocation failed.
TCP_CONNECTION_CLOSED—The connection to the Cisco IOS Gatekeeper has been closed. The application must call CloseGateKeeperConnection to free resources such as gkHandle in the GKAPI_SOCK_INFO structure.
INVALID_MSG_SPECIFIED—The message type is not within the RESPONSE_MSG_TYPE range.
HEADER_INFO_INCOMPLETE—One of the fields in the header (To, From, TransactionID) is incomplete.
NULL_POINTER_PASSED—The pointer to the GK_UNREGISTER_MSG is null.
GkapiSetupReport
This function allows the application to control the type of debug messages that the Gatekeeper API provides and the location of the debug output.
Input
The input for this function is:
An integer that indicates the type of debugging. If the debugging is set to 0, the Gatekeeper API will not output any debug messages.
A pointer to the REPORT_DEST_T enumeration, which indicates the destination for the debug messages.
Return
There is no return for this function.
GkapiQueryReport
This function returns the current debug setting for the Gatekeeper API.
Input
There is no input for this function.
Return
The return for this function is an integer that indicates the type of debugging being performed by the Gatekeeper API.
API Structures
The Gatekeeper API stores all data received from the Cisco IOS Gatekeeper in structures. The structures point to character strings, integers, and often enumerations (which are lists of possible values for a specific field). The structures used by the Gatekeeper API are:
The GKAPI_SOCK_INFO structure is used by several API functions to identify the connection to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-1:
Table 5-1 GKAPI_SOCK_INFO
Field
Field Type
Description
TCPPort
Integer
The TCP port of the Cisco IOS Gatekeeper that is establishing the incoming connection to the application.
IPAddress
Character string
The IP address of the Cisco IOS Gatekeeper that is establishing the incoming connection to the application.
gkHandle
Integer
Handle to the Cisco IOS Gatekeeper function.
serverHandle
Integer
Handle to the server function.
TCPPort and IPAddress are provided by the calling function. The API writes the handle into gkHandle and serverHandle when the connection is established. If an error is encountered in the handle creation or in the connection, the gkHandle will be set to -1. The external application is responsible for storing the handle and using it to read, write, and close the connection.
GKAPI_TCP_ADDR_INFO
The GKAPI_TCP_ADDR_INFO structure is used to store the TCP Port and IP address. This structure contains the fields shown in Table 5-2:
Table 5-2 GKAPI_TCP_ADDR_INFO
Field
Field Type
Description
TCPPort
Integer
The TCP port that the Cisco IOS Gatekeeper uses for handling GKTMP messages. For GkapiSetupServer, this is the TCP port that the application uses for interacting with the Gatekeeper.
IPAddress
Unsigned long
For GkapiSetupClient, this is the IP address that the Cisco IOS Gatekeeper uses for handling GKTMP messages. For GkapiSetupServer, this is the IP address that the application uses for interacting with the Gatekeeper.
GKAPI_VERSION_INFO
The GKAPI_VERSION_INFO structure is used to store the major and minor version numbers of the gatekeeper TMP and API. This structure contains the fields shown in Table 5-3:
Table 5-3 GKAPI_VERSION_INFO
Field
Field Type
Description
gkapi_major
Integer
The major number identifying the version of the API.
gkapi_minor
Integer
The minor number identifying the version of the API.
gktmp_major
Integer
The major number identifying the version of the TMP.
gktmp_minor
Integer
The minor number identifying the version of the TMP.
GKAPI_MAX_VER_STR_LEN
Character string
The build date and target operating system of the protocol.
gkapi_release_num
Integer
The release number of the gatekeeper API.
GK_CMD_MSG_TYPE
The GK_CMD_MSG_TYPE structure is used to process commands from the external application to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-4:
The CMD_HEADER_INFO structure is used to process header information sent by the application to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-5:
Table 5-5 CMD_HEADER_INFO
Field
Field Type
Description
versionId
Integer
Identifier of the version of GKTMP being used. For the initial release, the only possible value is 1.
from
Character string
Originator of the message. For commands from the external application, this field contains the server ID. The limit of this field is MAX_ENDPOINT_LENGTH + 1.
to
Character string
Receiver of the message. For commands from the external application, this field contains the ID of the gatekeeper that initiated the request. The limit of this field is MAX_ENDPOINT_LENGTH+1.
transactionID
Character string
Identifier of the transaction. If this field is present in the command to the Cisco IOS Gatekeeper, it must be echoed in the result to the external application. The limit of this field is MAX_TRANSACTION_ID_LENGTH + 1.
notification
Boolean
Whether the message is for notification purposes only.
GK_REGISTER_MSG
The GK_REGISTER_MSG structure is used to send registration messages to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-6:
The GK_UNREGISTER_MSG structure is used to send unregistration messages to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-7:
Identifier of the version of GKTMP being used. For the initial release, the only possible value is 1.
from
Character string
Originator of the message. For requests from the Cisco IOS Gatekeeper, this field contains the gatekeeper ID. For responses from the external application, this field contains the server ID. The limit of this field is MAX_ENDPOINT_LENGTH + 1.
to
Character string
Receiver of the message. For requests from the Cisco IOS Gatekeeper, this field contains the server ID. For responses from the external application, this field contains the ID of the gatekeeper that initiated the request. The limit of this field is MAX_ENDPOINT_LENGTH + 1.
priority
Integer
Priority of the filter. Possible values are 1 through 20. 1 is the highest priority.
REG_UNREG_RESP_MSG
The REG_UNREG_RESP_MSG structure is used to process registration and unregistration responses from the Cisco IOS Gatekeeper. This structure contains the field shown in Table 5-8:
The REGISTER_REQUEST_HEADER structure is used when a registration request is to be sent to Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-9:
Table 5-9 REGISTER_REQUEST_HEADER
Field
Field Type
Description
versionId
Integer
Identifier of the version of GKTMP being used. For the initial release, the only possible value is 1.
from
Character string
Originator of the message, which for registration requests is the server ID. The limit of this field is MAX_ENDPOINT_LENGTH+1.
to
Character string
Receiver of the message, which for registration requests is the gatekeeper ID The limit of this field is MAX_ENDPOINT_LENGTH+1.
priority
Integer
Priority of the filter. Possible values are 1 through 20. 1 is the highest priority.
notificationOnly
Boolean
Whether the registration request is for notifications only. If this field is set to True, messages that match the specified trigger parameters are sent on a notification-only basis.
REGISTER_RESPONSE_HEADER
The REGISTER_RESPONSE_HEADER structure is used when a registration or unregistration response is received from the Cisco IOS Gatekeeper. The registration or unregistration response is received after the application sends a registration or unregistration request to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-10:
Table 5-10 REGISTER_RESPONSE_HEADER
Field
Field Type
Description
version-id
Integer
Identifier of the version of GKTMP being used. For the initial release, the only possible value is 1.
from
Character string
Originator of the message, which for registration responses is the gatekeeper ID. The limit of this field is MAX_ENDPOINT_LENGTH+1.
to
Character string
Receiver of the message, which for registration responses is the server ID. The limit of this field is MAX_ENDPOINT_LENGTH+1.
priority
Integer
Priority of the filter. Possible values are 1 through 20. 1 is the highest priority.
Sequence of alias addresses for the destination endpoint. The limit of this field is MAX_NUM_ARQ_DEST_INFO.
redirectReason
Enumeration
Taken from the Q.931 Setup Redirecting Number IE. See REDIRECT_REASON_TYPE. The limit of this field is MAX_NUM_ARQ_REDIRECT_REASON.
RRQ_REGISTER_MSG
The RRQ_REGISTER_MSG structure is used to send registrations for RRQ requests to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-12:
Type of endpoint being registered. See ENDPOINT_TYPE. The limit of this field is MAX_NUM_ENDPOINT_TYPES.
supportedPrefix
Character string
Prefix associated with the supported protocol. The limit of this field is MAX_NUM_SUPPORTED_PREFIX.
URQ_REGISTER_MSG
The URQ_REGISTER_MSG structure is used to send registrations for URQ requests to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-13:
Sequence of alias addresses for the destination endpoint. The limit of this field is MAX_NUM_LRQ_DEST_INFO.
redirectReason
Enumeration
Taken from the Q.931 Setup Redirecting Number IE. See REDIRECT_REASON_TYPE. The limit of this field is MAX_NUM_LRQ_REDIRECT_REASON.
LCF_REGISTER_MSG
The LCF_REGISTER_MSG structure is used to send registrations for LCF requests to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-15:
Sequence of alias addresses for the destination endpoint. The limit of this field is MAX_NUM_LCF_DEST_INFO.
rmotExtensionAddr
Character String
Alias address of a called endpoint, present in cases where this information is required to traverse multiple gateways. The limit of this field is MAX_NUM_LCF_RMOT_EXTENSION_ADDR.
LRJ_REGISTER_MSG
The LRJ_REGISTER_MSG structure is used to send registrations for LRJ requests to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-16:
Type of endpoint. See ENDPOINT_TYPE. The limit of this field is MAX_NUM_ENDPOINT_TYPES.
supportedPrefix
Character string
Prefix associated with the supported protocol. The limit of this field is MAX_NUM_SUPPORTED_PREFIX.
DRQ_REGISTER_MSG
The DRQ_REGISTER_MSG structure is used to send registrations for DRQ requests to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-18:
Sequence of alias addresses for the destination endpoint. The limit of this field is MAX_NUM_ARQ_DEST_INFO.
redirectReason
Enumeration
Taken from the Q.931 Setup Redirecting Number IE. See REDIRECT_REASON_TYPE. The limit of this field is MAX_NUM_LRQ_REDIRECT_REASON.
BRQ_REGISTER_MSG
The BRQ_REGISTER_MSG structure is used to send registrations for BRQ requests to the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-19:
Sequence of alias addresses for the destination endpoint. The limit of this field is MAX_NUM_ARQ_DEST_INFO.
redirectReason
Enumeration
Taken from the Q.931 Setup Redirecting Number IE. See REDIRECT_REASON_TYPE. The limit of this field is MAX_NUM_ARQ_REDIRECT_REASON.
GK_READ_MSG
The GK_READ_MSG structure is used process REQUEST messages from the Cisco IOS Gatekeeper for the supported RAS messages, as well as registration and unregistration responses from the Cisco IOS Gatekeeper for the supported RAS messages. This structure contains the fields shown in Table 5-20:
If the message received from the Cisco IOS Gatekeeper is a RAS message that is not supported by the API function, the msgType is set to MSG_NOT_SUPPORTED. If a response is required, an appropriate response is constructed by the API function and sent to the Cisco IOS Gatekeeper. The header information in the UNSUPPORTED_MSG structure is filled in by the API function. This situation could occur if the Cisco IOS Gatekeeper has been upgraded to support new messages but the API function has not been correspondingly upgraded.
If the message received from the Cisco IOS Gatekeeper, is not recognized by the API function, the msgType is set to UNKNOWN_MSG and the STATUS_TYPE is set to MSG_READ_ERROR. In this case, the external application should close the connection to the Cisco IOS Gatekeeper by calling the CloseGateKeeperConnection function.
HEADER_INFO
The HEADER_INFO structure is used to process header information sent from the Cisco IOS Gatekeeper or information that is sent by the application to the Cisco IOS Gatekeeper.
This structure contains the fields shown in Table 5-21:
Table 5-21 HEADER_INFO
Field
Field Type
Description
versionId
Integer
Identifier of the version of GKTMP being used. For the initial release, the only possible value is 1.
from
Character string
Originator of the message. For requests from the Cisco IOS Gatekeeper, this field contains the gatekeeper ID. For responses from the external application, this field contains the server ID. The limit of this field is MAX_ENDPOINT_LENGTH + 1.
to
Character string
Receiver of the message. For requests from the Cisco IOS Gatekeeper, this field contains the server ID. For responses from the external application, this field contains the ID of the gatekeeper that initiated the request. The limit of this field is MAX_ENDPOINT_LENGTH+1.
transactionID
Character string
Identifier of the transaction. If this field is present in the request from the Cisco IOS Gatekeeper, it must be echoed in the response from the external application. The limit of this field is MAX_TRANSACTION_ID_LENGTH + 1.
notification
Boolean
Whether the message is for notification purposes only. This field is used only in REQUEST messages that are received from the Cisco IOS Gatekeeper.
ARQ_REQUEST_MSG
The ARQ_REQUEST_MSG structure is used to process ARQ requests from the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-22:
Sequence of alias addresses for the source endpoint.
srcCallSignalAddress
Character string
Transport address used at the source for call signaling.
destinationInfo
Character string
Sequence of alias addresses for the destination endpoint.
destCallSignalAddress
Character string
Transport address used at the destination for call signaling.
destExtraCallInfo
Character string
External addresses for multiple calls.
bandWidthPresent
Boolean
Whether a specified bandwidth is present in the request.
bandWidth
Unsigned integer
Bandwidth (in 100 kbps) requested for the bi-directional call.
answerCall
Integer
Indicates to the Cisco IOS Gatekeeper that the call is incoming.
callIdentifier
Character string
A unique call identifier (set by the originating endpoint), which can be used to associate RAS signaling with the modified Q.931 signaling used in H.225.0.
conferenceID
Character string
A unique conference identifier.
canMapAlias
Integer
Whether the endpoint can copy information from the resulting ACF into the destinationAddress, destExtraCallInfo, and remoteExtensionAddress fields of the SETUP message.
redirectNumber
Character string
Taken from the Number Digits field of Q.931 Setup Redirecting Number IE.
Generic Transparency Descriptor. Defines parameters and messages of existing SS7 ISUP protocols
terminationCause
Character String
Informs the GKTMP server of the release complete Cause IE that was sent to the gatekeeper. See TERMINATION_CAUSE_TYPE.
r_count
Unsigned Integer
Used to send additional ARQ messages to the gatekeeper and then to a route server after all alternative endpoints returned in the first ARQ message have failed. Subsequent ARQ messages use the same global call ID and also have a reroute count of one for the first reroute request, which is incremented for each subsequent reroute request.
Whether the calling number information can be displayed.
displayIE
Character String
Taken from the Q.931 Setup, display IE.
callingPartyNum
Character String
Taken from the Q.931.
srcCarrierID
Character String
Carrier identifier of an inbound call
dstCarrierID
Character String
Target carrier identifier of an outbound call
bandWidthPresent
Boolean
Indicates if bandwidth has been received
bandWidth
Unsigned Integer
Bandwidth (in 100 kpbs) requested for a bidirectional call
callIdentifier
Character String
Indicates the type of call, such as a voice call
srcTrunkGroup
Character String
Source trunk group identifier of an inbound call
dstTrunkGroup
Character String
Destination trunk group identifier of an outbound call
gtd
Character String
Generic Transparency Descriptor. Defines parameters and messages of existing SS7 ISUP protocols
terminationCause
Character String
Informs the GKTMP server of the release complete Cause IE that was sent to the gatekeeper. See TERMINATION_CAUSE_TYPE.
r_count
Unsigned Integer
Used to send additional ARQ messages to the gatekeeper and then to a route server after all alternative endpoints returned in the first ARQ message have failed. Subsequent ARQ messages use the same global call ID and also have a reroute count of one for the first reroute request, which is incremented for each subsequent reroute request.
LCF_REQUEST_MSG
The LCF_REQUEST_MSG structure is used to process LCF requests from the Cisco IOS Gatekeeper. This structure contains the fields shown in Table 5-26:
Reason received for a DRQ sent by an endpoint. See DRQ_REASON_TYPE.
srcCallSignalAddress
Character string
Transport address used at the source for call signaling.
answeredCall
Integer
Indicates that this party was the original destination. The value is TRUE or FALSE.
callIdentifier
Character string
A unique call identifier (set by the originating endpoint) which can be used to associate RAS signaling with the modified Q.931 signaling used in H225.0.
Indicates to the Cisco IOS Gatekeeper that the call is incoming.
bandWidth
Unsigned integer
Bandwidth (in 100 kbps) requested for the bi-directional call.
callIdentifier
Character string
A unique call identifier (set by the originating endpoint), which can be used to associate RAS signaling with the modified Q.931 signaling used in H.225.0.
conferenceID
Character string
A unique conference identifier.
endPointCallSignal Address
Character string
Call signalling transport address for this endpoint.
The CRYPTO_EP_PWD_HASH structure is used to process cryptoTokens. This structure contains the sections shown in Table 5-48:
Table 5-48 CRYPTO_EP_PWD_HASH
Field
Field Type
Description
alias
Character string
Registration and status transport address for this endpoint.
timestamp
Character string
32-bit integer that represents UTC time.
token
Character string
16 octet IA5String that represents the MD5 hashed encoded PwdCertToken.
CRYPTO_EP_PWD_ENCR
The CRYPTO_EP_PWD_ENCR structure is used to process the encrypted data of a cryptoToken. This structure contains the fields shown in Table 5-49:
Table 5-49 CRYPTO_EP_PWD_ENCR
Field
Field Type
Description
paramS
Character string
Any runtime parameters.
encryptedData
Character string
Encrypted data from the cryptoToken.
CRYPTO_EP_CERT
The CRYPTO_EP_CERT structure is used to process the authentication certificate of a cryptoToken. This structure contains the fields shown in Table 5-50:
Table 5-50 CRYPTO_EP_CERT
Field
Field Type
Description
toBeSigned
Character string
Whether the certificate requires a signature.
signature
Character string
Digital signature assigned to the authentication certificate.
CLEAR_TOKEN
The CLEAR_TOKEN structure is used to process the clear tokens field. This structure contains the fields shown in Table 5-51:
Table 5-51 CLEAR_TOKEN
Field
Field Type
Description
objectIdentifier
Character string
Object identifier.
password
Character string
Secret character string that is used to authenticate a user or H.323 endpoint.
timestamp
Character string
32-bit integer that represents UTC time.
challengeString
Character string
Challenge string used for authentication.
random
Character string
Integer value, for example a monotonically increasing sequence number.
generalID
Character string
Character string that uniquely identifies either the sender or receiver.
nonstd_objectID
Character string
Object identifier that is used to indicate the type and format of the nonstandard data being sent in the clear token.
nonstd_data
Character string
Nonstandard data in the clear tokens field.
ALTERNATE_GK
The ALTERNATE_GK structure is used to process information about an alternate gatekeeper. This structure contains the fields shown in Table 5-52:
Table 5-52 ALTERNATE GK
Field
Field Type
Description
rasAddress
Character string
Registration and status transport address for this endpoint.
gkIdentifier
Character string
Identifier of the gatekeeper.
needToRegister
Boolean
Whether there is a need to register with this gatekeeper.
priority
Integer
Priority of this gatekeeper. Possible values are 1 through 127.
ALTERNATE_ENDPOINT
The ALTERNATE_ENDPOINT structure is used to process information about an alternate H.323 endpoint.
This structure contains the fields shown in Table 5-53:
Table 5-53 ALTERNATE_ENDPOINT
Field
Field Type
Description
callSignalAddress
Character string
Registration and status transport address for this endpoint.
The ALTERNATE_TRANSPORT_ADDR_TYPE structure is used to convey information about an Annex E transport address of the destination H.323 endpoint. This structure contains the fields shown in Table 5-54:
Table 5-54 ALTERNATE_TRANSPORT_ADDR_TYPE
Field
Field Type
Description
annexE
Character string
Annex E transport address of the destination endpoint.
nextP
Pointer
Pointer to the next node in the linked list.
RIP_RESPONSE_MSG
The RIP_RESPONSE_MSG structure is used to process requests from the external application for additional time. This structure contains the fields shown in Table 5-55:
Amount of time, in milliseconds (1 through 65,536), that the endpoint should wait before retrying the request.
UNSUPPORTED_MSG
The UNSUPPORTED_MSG structure is used to process requests from the Cisco IOS Gatekeeper that contain a RAS message type that is not supported by the API. This structure contains the field shown in Table 5-56:
Table 5-57 shows the fields for the SERV_CNTRL_TYPE structure:
Table 5-57 SERV_CNTRL_TYPE
Field
Field Type
Description
serviceDescriptor
Character String
Code for use in authentication with RADIUS server by endpoint
reason
Character String
Indicates whether this is a new session (open), a modification to an existing session (refresh), or that the session is being terminated by the provider (close) and existing resources, such as a GUI, should be closed.
sessionId
Unsigned Integer
Integer that identifies the current session. This integer is unique for each client.
Note Identifiers received through different signaling paths may overlap.
URQ_CMD_MSG_TYPE
Table 5-58 shows the fields for the URQ_CMD_MSG_TYPE structure:
Table 5-58 URQ_CMD_MSG_TYPE
Field
Field Type
Description
callSignalAddress
Character String
Call signaling address of the endpoint to unregister.
Table 5-59 shows the fields for the URQ_RESULT_MSG structure:
Table 5-59 URQ_RESULT_MSG
Field
Field Type
Description
callSignalAddress
Character String
Call signaling address of the unregistered endpoint.
CALL_CAPACITY
Table 5-60 shows the fields for the CALL_CAPACITY structure:
Table 5-60 CALL_CAPACITY
Field
Field Type
Description
call_protocol
Pointer
Defines the protocol supported by the endpoint for the call
calls_available
Pointer
Provides call statistics
CALLS_AVAILABLE
Table 5-61 shows the fields for the CALLS_AVAILABLE structure:
Table 5-61 CALLS_AVAILABLE
Field
Field Type
Description
groupID
Character String
Name of the carrier or service provider
bit_mask
Unsigned Character
Used to present either maximum or current calls available
max_call_available
Integer
Maximum calls available
current_calls_available
Integer
Current calls available
CARRIER_INFO
Table 5-62 shows the fields for the CARRIER_INFO structure:
Table 5-62 CARRIER_INFO
Field
Field Type
Description
dstCarrierID
Character String
Target carrier identifier of an outbound call
destinationInfo
Character String
Identifies the service provider offering the VoIP call to the gateway
sourceInfo
Character String
Identifies the service provider offering the VoIP call to the gateway
priority
Integer
Priority associated with the carrier
rzone
Pointer
Remote zone information to which the gateway can LRQ to
PER_CALLINFO
Table 5-63 shows the fields for the PER_CALLINFO structure:
Table 5-63 PER_CALLINFO
Field
Field Type
Description
callIdentifier
Character String
Call Identifier of the call
conferenceID
Character String
Conference identifier for the call
originator
Boolean
Whether the sender was the originator of the call
bandWidth
Unsigned Integer
Bandwidth (in 100 kpbs) requested for a bidirectional call
startTime
Unsigned Long
Start time of the call
srcZone
Character String
Source zone for the call
dstZone
Character String
Destination zone for the call
srcCarrierID
Character String
Source carrier identifier of the call
dstCarrierID
Character String
Destination carrier identifier for the call
sourceTrunk
Character String
Source trunk group identifier of the call
destTrunk
Character String
Destination trunk group identifier for the call
REMOTE_ZONE
Table 5-64 shows the fields for the REMOTE_ZONE structure:
Table 5-64 REMOTE_ZONE
Field
Field Type
Description
rasAddress
Character String
Registration and status address for the remote gatekeeper
cost
Unsigned Integer
Cost factor associated with the remote zone
priority
Unsigned Integer
Priority associated with the remote zone
TERMINATION_CAUSE_TYPE
Table 5-65 shows the fields for the TERMINATION_CAUSE_TYPE structure:
Table 5-65 TERMINATION_CAUSE_TYPE
Field
Field Type
Description
codingStd
Unsigned Integer
Coding standard
location
Unsigned Integer
Location
recommend
Unsigned Integer
Recommendation
relCause
Unsigned Integer
Cause value
diag0
Unsigned Integer
Diagnostic
diag1
Unsigned Integer
Diagnostic
diag2
Unsigned Integer
Diagnostic
relReason
Unsigned Integer
Reason value
Enumerations
Some of the API structures contain enumerations. An enumeration is simply a list of possible values. This section lists the enumerations used by the structures and includes the following sections:
The STATUS_TYPE enumeration lists the possible return values from calls to read, write, register and unregister functions. The possible values are:
PROCESSING_SUCCESSFUL
CONNECT_IN_PROGRESS
NULL_POINTER_PASSED
TCP_HANDLE_ERROR
TCP_CONNECT_ERROR
TCP_READ_ERROR
TCP_BIND_ERROR
TCP_LISTEN_ERROR
TCP_ADDRESS_ALREADY_IN_USE
TCP_ADDRESS_NOT_AVAIL
TCP_NONBLOCK_ERROR
MEM_ALLOC_FAIL
MSG_READ_ERROR
TCP_WRITE_ERROR
TCP_CONNECTION_CLOSED
INCOMPLETE_MSG_READ
INVALID_MSG_SPECIFIED
INVALID_ENDPOINT_SPECIFIED
INVALID_REDIRECT_REASON_SPECIFIED
INVALID_REJECT_REASON_SPECIFIED
INVALID_DELAY_SPECIFIED
HEADER_INFO_INCOMPLETE
REG_STATUS_TYPE
The REG_STATUS_TYPE enumeration lists the possible status values for registration and unregistration responses received from the Cisco IOS Gatekeeper. The possible values are:
SUCCESSFUL
INVALID_PRIORITY
INVALID_FILTERS
INVALID_GKID
ENDPOINT_TYPE
The ENDPOINT_TYPE enumeration lists the possible types of endpoints. The possible values are:
GATEKEEPER
TERMINAL
MCU
PROXY
VOICEGATEWAY
H320GATEWAY
OTHERGATEWAY
ENDPOINT_INFO_NOT_RCVD
REDIRECT_REASON_TYPE
The REDIRECT_REASON_TYPE enumeration lists the possible reasons that a call might be redirected. The possible values are:
REDIRECT_REASON_UNKNOWN = 0
REDIRECT_REASON_CALL_FWD_BUSY = 1
REDIRECT_REASON_CALL_FWD_NO_REPLY = 2
REDIRECT_REASON_CALL_DEFLECTION = 4
REDIRECT_REASON_CLED_DTE_OUT_OF_ORDER = 9
REDIRECT_REASON_CALL_FWDING_BY_CLED_DTE = 10
REDIRECT_REASON_CALL_FWDING_UNCONDL = 15
REDIRECT_REASON_INFO_NOT_RCVD= 99
DRQ_REASON_TYPE
The DRQ_REASON_TYPE enumeration lists the reasons received for a DRQ sent by an endpoint. The possible values are:
DRQ_REASON_FORCED_DROP = 1
DRQ_REASON_NORMAL_DROP = 2
DRQ_REASON_UNDEF_REASON = 3
LRJ_REJECT_REASON_TYPE
The LRJ_REJECT_REASON_TYPE enumeration lists the possible reasons that an LRQ request might be rejected. The possible values are:
LRJ_NOT_REGISTERED
LRJ_INVALID_PERMISSION
LRJ_REQUEST_DENIED
LRJ_UNDEFINED_REASON
LRJ_SECURITY_DENIAL
REQUEST_MSG_TYPE
The REQUEST_MSG_TYPE enumeration lists the possible messages that can be received from the Cisco IOS Gatekeeper. The possible values are:
UNKNOWN_MSG
MSG_NOT_SUPPORTED
RRQ_REQUEST_MSG
URQ_REQUEST_MSG
ARQ_REQUEST_MSG
LRQ_REQUEST_MSG
LRJ_REQUEST_MSG
LCF_REQUEST_MSG
BRQ_REQUEST_MSG
RAI_REQUEST_MSG
DRQ_REQUEST_MSG
RRQ_REGISTER_RESPONSE_MSG
URQ_REGISTER_RESPONSE_MSG
ARQ_REGISTER_RESPONSE_MSG
LRQ_REGISTER_RESPONSE_MSG
LCF_REGISTER_RESPONSE_MSG
LRJ_REGISTER_RESPONSE_MSG
BRQ_REGISTER_RESPONSE_MSG
RAI_REGISTER_RESPONSE_MSG
DRQ_REGISTER_RESPONSE_MSG
RRQ_UNREGISTER_RESPONSE_MSG
URQ_UNREGISTER_RESPONSE_MSG
ARQ_UNREGISTER_RESPONSE_MSG
LRQ_UNREGISTER_RESPONSE_MSG
LCF_UNREGISTER_RESPONSE_MSG
LRJ_UNREGISTER_RESPONSE_MSG
BRQ_UNREGISTER_RESPONSE_MSG
RAI_UNREGISTER_RESPONSE_MSG
DRQ_UNREGISTER_RESPONSE_MSG
RRJ_REJECT_REASON_TYPE
The RRJ_REJECT_REASON_TYPE enumeration lists the possible reasons that an RRQ request might be rejected. The possible values are:
RRJ_UNDEFINED_REASON
RRJ_SECURITY_DENIAL
RRJ_RESOURCE_UNAVAIL
ARJ_REJECT_REASON_TYPE
The ARJ_REJECT_REASON_TYPE enumeration lists the possible reasons that an ARQ request might be rejected. The possible values are:
CALLED_PARTY_NOT_REGISTERED
INVALID_PERMISSION
REQUEST_DENIED
UNDEFINED_REASON
ARJ_RESOURCE_UNAVAIL
ARJ_SECURITY_DENIAL
BRJ_REJECT_REASON_TYPE
The BRJ_REJECT_REASON_TYPE enumeration lists the possible reasons that a BRQ request might be rejected. The possible values are:
BRJ_NOT_BOUND
BRJ_INVALID_CONF_ID
BRJ_INVALID_PERMISSION
BRJ_INSUFFICIENT_RSC
BRJ_INVALID_REVISION
BRJ_UNDEFINED_REASON
BRJ_SECURITY_DENIAL
URQ_REASON_TYPE
The URQ_REASON_TYPE enumeration lists the reasons sent in the URQ message to unregister an endpoint. The possible values are:
URQ_REASON_REREG_REQ = 1
URQ_REASON_TTL_EXP = 2
URQ_REASON_SEC_DNL = 3
URQ_REASON_UNDEF = 4
URQ_REASON_MAINTENANCE = 5
URQ_REASON_NOT_SPECIFIED = 99
RESPONSE_MSG_TYPE
The RESPONSE_MSG_TYPE enumeration lists the possible messages that the external application can send to the Cisco IOS Gatekeeper. The possible values are:
RRQ_RESPONSE_MSG
RCF_RESPONSE_MSG
RRJ_RESPONSE_MSG
ARQ_RESPONSE_MSG
ACF_RESPONSE_MSG
ARJ_RESPONSE_MSG
LRQ_RESPONSE_MSG
LCF_RESPONSE_MSG
LRJ_RESPONSE_MSG
RIP_RESPONSE_MSG
BRQ_RESPONSE_MSG
BCF_RESPONSE_MSG
BRJ_RESPONSE_MSG
REGISTER_MSG_TYPE
The REGISTER_MSG_TYPE enumeration lists the possible registration messages that the external application can send to the Cisco IOS Gatekeeper. The possible values are:
RRQ_REGISTER_MSG
URQ_REGISTER_MSG
ARQ_REGISTER_MSG
LRQ_REGISTER_MSG
LCF_REGISTER_MSG
LRJ_REGISTER_MSG
BRQ_REGISTER_MSG
RAI_REGISTER_MSG
DRQ_REGISTER_MSG
REPORT_DEST_T
The REPORT_DEST_T enumeration lists the possible destinations for the Gatekeeper API debug output. The possible values are:
REPORT_CONSOLE
REPORT_SYSLOG
CRYPTO_H323_TOKEN_TYPE_S
The CRYPTO_H323_TOKEN_TYPE_S enumeration lists the possible types of cryptoTokens. The possible values are:
NO_CRYPTO_TOKEN
CRYPTO_EP_PWD_HASH
CRYPTO_EP_PWD_ENCR
CRYPTO_EP_CERT
Note In the first release of the GKTMP and API, the CRYPTO_EP_PWD_HASH is the only type of
cryptoToken supported.
USE_SPECIFIED_TRANSPORT_TYPE_T
The USE_SPECIFIED_TRANSPORT_TYPE_T enumeration lists the possible transport types that an endpoint can select for H.225 signalling. The possible values are:
TRANSPORT_NONE
ANNEX_E
TCP
CMD_MSG_TYPE
The CMD_MSG_TYPE enumeration lists the possible messages that the external application can send as spontaneous commands to the Cisco IOS Gatekeeper. The possible value is:
URQ_CMD_MSG
Limits
Some of the fields are limited in size. The limits are set using variables in the header file. The limits as set in the default header file are shown in Table 5-66: