IBM SC33-1683-02 - Manual (Page 9)

Introduction to the task-related user exit mechanism (the adapter). . . . . . 249
The stub program
. . . . . . . . . . . . . . . . . . . . . . . 250
Returning control to the application program . . . . . . . . . . . . . 251
Task-related user exits and EDF . . . . . . . . . . . . . . . . . 252
The task-related user exit program . . . . . . . . . . . . . . . . . 252
User exit parameter lists . . . . . . . . . . . . . . . . . . . . 253
The schedule flag word . . . . . . . . . . . . . . . . . . . . 265
Register handling in the task-related user exit program . . . . . . . . . 266
Addressing-mode implications . . . . . . . . . . . . . . . . . . 267
Exit programs and the CICS storage protection facility . . . . . . . . . 267
Recursion within a task-related user exit program . . . . . . . . . . . 268
Using CICS services in your task-related user exit program . . . . . . . 268
Work areas . . . . . . . . . . . . . . . . . . . . . . . . . 269
Coding a program to be invoked by the CICS SPI
. . . . . . . . . . 270
Coding a program to be invoked by the CICS syncpoint manager . . . . . 270
Coding a program to be invoked by the CICS task manager . . . . . . . 274
Coding a program to be invoked at CICS termination
. . . . . . . . . 275
Using EDF with your task-related user exit program . . . . . . . . . . 278
Adapter administration . . . . . . . . . . . . . . . . . . . . . . 280
What you must do before using the adapter . . . . . . . . . . . . . 280
Tracing a task-related user exit program . . . . . . . . . . . . . . 282
Chapter 3. The user exit programming interface (XPI) . . . . . . . . . 283
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . 283
General form of an XPI call . . . . . . . . . . . . . . . . . . . . 286
Setting up the XPI environment . . . . . . . . . . . . . . . . . 290
XPI register usage . . . . . . . . . . . . . . . . . . . . . . 291
The XPI copy books
. . . . . . . . . . . . . . . . . . . . . 291
Reentrancy considerations resulting from XPI calls . . . . . . . . . . 291
Global user exit XPI examples, showing the use of storage . . . . . . . . 292
An example showing how to build a parameter list incrementally . . . . . 297
The XPI functions . . . . . . . . . . . . . . . . . . . . . . . 298
Dispatcher functions . . . . . . . . . . . . . . . . . . . . . . 300
Synchronization protocols for SUSPEND and RESUME processing . . . . 300
The ADD_SUSPEND call. . . . . . . . . . . . . . . . . . . . 302
The SUSPEND call . . . . . . . . . . . . . . . . . . . . . . 304
The RESUME call . . . . . . . . . . . . . . . . . . . . . . 307
The DELETE_SUSPEND call . . . . . . . . . . . . . . . . . . 308
The WAIT_MVS call
. . . . . . . . . . . . . . . . . . . . . 309
The CHANGE_PRIORITY call . . . . . . . . . . . . . . . . . . 313
Dump control functions . . . . . . . . . . . . . . . . . . . . . 314
The SYSTEM_DUMP call . . . . . . . . . . . . . . . . . . . 314
The TRANSACTION_DUMP call . . . . . . . . . . . . . . . . . 316
Enqueue domain functions . . . . . . . . . . . . . . . . . . . . 318
The ENQUEUE function . . . . . . . . . . . . . . . . . . . . 318
The DEQUEUE function . . . . . . . . . . . . . . . . . . . . 319
Kernel domain functions . . . . . . . . . . . . . . . . . . . . . 320
The START_PURGE_PROTECTION function . . . . . . . . . . . . 320
The STOP_PURGE_PROTECTION function. . . . . . . . . . . . . 320
Nesting purge protection calls . . . . . . . . . . . . . . . . . . 321
Loader functions . . . . . . . . . . . . . . . . . . . . . . . . 321
The DEFINE_PROGRAM call . . . . . . . . . . . . . . . . . . 321
The ACQUIRE_PROGRAM call . . . . . . . . . . . . . . . . . 325
The RELEASE_PROGRAM call . . . . . . . . . . . . . . . . . 327
The DELETE_PROGRAM call . . . . . . . . . . . . . . . . . . 328
Log manager functions . . . . . . . . . . . . . . . . . . . . . 329
Contents vii