EPI events occur when CICS® has
data to pass to the EPI application.
The application can handle EPI events in a variety of ways. See Events
and callbacks.
Whichever mechanism is used, the data from CICS is obtained
by calling CICS_EpiGetEvent.
CICS_EPI_EVENT_ADD_TERM
The CICS_EPI_EVENT_ADD_TERM event indicates that an asynchronous
request to install a terminal resource has completed. If the terminal
resource was installed details will have been placed in the CICS_EpiDetails_t structure,
pointed to by Data.
CICS_EPI_EVENT_SEND
The CICS_EPI_EVENT_SEND event indicates that a transaction
has sent some 3270 data to a terminal resource, typically as a result
of an EXEC CICS SEND
command. No reply is expected, and none should be attempted.
CICS_EPI_EVENT_CONVERSE
The CICS_EPI_EVENT_CONVERSE event indicates that a transaction
is expecting a reply as a result of either an EXEC CICS RECEIVE
command, or an EXEC CICS CONVERSE
command.
CICS_EPI_EVENT_END_TRAN
The CICS_EPI_EVENT_END_TRAN event indicates the end of
a transaction that was running against a terminal resource. If the
transaction failed, the EndReason and EndReturnCode specify
the cause.
CICS_EPI_EVENT_START_ATI
The CICS_EPI_EVENT_START_ATI event indicates that an ATI
transaction has been started against the terminal resource. If the
terminal resource receives an ATI request while it is running another
transaction, the request is held until the transaction ends. The transaction
is then started on behalf of the terminal resource, and the CICS_EPI_EVENT_START_ATI
event is generated to inform the application.
CICS_EPI_EVENT_END_TERM
The CICS_EPI_EVENT_END_TERM event indicates that a terminal
resource no longer exists. After this event, the terminal index that
was previously used for the terminal resource is not valid. If the
EPI detects that a CICS server has shut down, CICS_EPI_EVENT_END_TERM
events are generated for all terminal resources that the application
has installed in that server and not subsequently deleted.