User Exits

C Proxy › Executing the User-written C Proxy Application › Configuring the C Proxy at Runtime › User Exits

User Exits

The user exits that are invoked at runtime for a C Proxy are common to other C/C++ execution environments.

Note: For more information about the details of each user exit, see the User Exit Reference Guide.

A set of user exits is invoked from within the C Proxy runtime regardless of the selected communication type. There are other user exits, which are unique for each communications type.

The following user exit entry points are common to all C Proxies, regardless of communications type:

User Exit Entry Point	Purpose
WRSECTOKEN	The Client Security user exit is used to direct the runtime to incorporate the ClientUserid and ClientPassword attributes into the CFB. If this exit returns SECURITY_ENHANCED, it can cause an optional Security Token field to be added to the CFB.
WRSECENCRYPT	The import message encryption user exit provides the opportunity for a portion of the outbound CFB to be encrypted using an encryption algorithm implemented within this user exit. The target DPS's execution environment must implement a companion decryption user exit for the CFB to be interpreted as a valid request CFB.
WRSECDECRYPT	The export message decryption user exit provides the opportunity for decrypting the portion of the CFB that has been encrypted by the target DPS's execution environment. This exit must implement the companion to the DPS's encryption user exit in order for the DPS's response buffer to be interpreted as a valid response CFB.

The following user exit entry points are invoked by C Proxies flowing to their target DPS using TCP/IP as their communications type:

User Exit Entry Point	Purpose
CI_TCP_DPC_DirServ_Exit	Overrides the destination information used when creating the TCP/IP Socket.
CI_TCP_DPC_setupComm_Complete	Directs the runtime to retry a cooperative flow request that failed during setup.
CI_TCP_DPC_handleComm_Complete	Directs the runtime to retry a cooperative flow request that failed during the non-setup related processing of a cooperative flow.

The following user exit entry points are invoked by C Proxies flowing to their target DPS using ECI as their communications type:

User Exit Entry Point	Purpose
ci_eci_get_system_name	Provides the CICS system name, if one has not previously been provided by data obtained from the commcfg.ini file.
ci_eci_get_tpn	Provides that capability to specify an alternate CICS Mirror Transaction name. The default Mirror Transaction will be CPMI unless overridden by this exit.

The following user exit entry points are invoked by C Proxies flowing to their target DPS using MQSeries as their communications type:

User Exit Entry Point	Purpose
CI_MQS_DPC_Exit	Overrides various pieces of information used to interface with MQSeries.
CI_MQS_DyanmicQName_Exit	Overrides the default structure of Dynamic Reply to Queues.
CI_MQS_DPC_setupComm_Complete	Directs the runtime to retry a cooperative flow request that failed during setup.
CI_MQS_DPC_handleComm_Complete	Directs the runtime to retry a cooperative flow request that failed during the non-setup related processing of a cooperative flow.
CI_MQS_MQShutdownTest	Overrides the default behavior of keeping the connection to the Queue Manager following the completion of a cooperative flow.

The following user exit entry points are invoked by C Proxies flowing to their target DPS using Tuxedo as their communications type:

User Exit Entry Point	Purpose
ci_c_sec_set	Sets user supplied security data into the security data fields located in Tuxedo's TPINIT structure.
ci_c_user_data_out	Gives the user the opportunity to inspect or modify the cooperative flow request buffer prior to Tuxedo sending the request to the target Tuxedo service.
ci_c_user_data_in	Gives the user the opportunity to inspect or modify the cooperative flow request buffer on return from the target Tuxedo service. Invoked on return from the TPCALL. Additionally, this exit lets the client to disconnect from the server following each flow.

The following user exit entry points are invoked by C Proxies flowing to their target DPS using Web Services as their communications type:

User Exit Entry Point	Purpose
CI_WS_DPC_Exit	Gives the user an opportunity to modify the Web Service endpoint destination by overriding the base URL and the context type.
CI_WS_DPC_URL_Exit	Gives the user an opportunity to modify the Web Service endpoint destination URL.

More information:

.NET Proxy

Java Proxy

Java Proxy (Classic Style)