Cisco Cisco IOS Software Release 12.2(15)T Guide Du Développeur

This function writes a response message to the Cisco IOS Gatekeeper. This structure contains 

, 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-addresses must 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.

 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)

REDIRECT_REASON_TYPE—REDIRECT_REASON_INFO_NOT_RCVD 

ENDPOINT_TYPE—ENDPOINT_INFO_NOT_RCVD

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.

The input for this function is:

A pointer to the 

 structure.

A pointer to the 

 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.

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.