Cisco Cisco IOS Software Release 12.2(15)T Guide Du Développeur
5-9
Cisco Gatekeeper External Interface Reference, Version 4.2
Cisco IOS Release 12.2(15)T
Chapter 5 Gatekeeper API Functions and Structures
Gatekeeper API Functions
•
TCP_WRITE_ERROR—A TCP write error was encountered. The application should call
CloseGateKeeperConnection to close the connection to the Cisco IOS Gatekeeper.
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.
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.
range.
•
INVALID_ENDPOINT_SPECIFIED—The endpoint does not match one of the possible values for
ENDPOINT_TYPE.
ENDPOINT_TYPE.
•
INVALID_REDIRECT_REASON_SPECIFIED—The redirect reason does not match one of the
possible values for REDIRECT_REASON_TYPE.
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.
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.
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,
dynamically registered with the Cisco IOS Gatekeeper. This structure,
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.
“notification-only” fields.
Input
The input for this function is:
•
A pointer to the
structure.
•
A pointer to the
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.
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
. 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.
after some time has passed.