The suspend call, The suspend call” on, Response and reason values for add_suspend – IBM SC33-1683-02 User Manual

Page 336

Advertising
background image

RESPONSE and REASON values for ADD_SUSPEND:

RESPONSE

REASON

OK

None

EXCEPTION

None

DISASTER

None

INVALID

None

KERNERROR

None

PURGED

None

Note: For more detail, refer to the explanation of RESPONSE and REASON in

“General form of an XPI call” on page 286.

The SUSPEND call

SUSPEND suspends execution of a running task. The task can be resumed in one
of two ways. You can issue the XPI RESUME call, or the task is resumed
automatically if the INTERVAL value that you specify on the DFHDSSRX macro
expires. Suspended tasks can also be purged by the operator, or by an application,
or by the deadlock time-out facility.

SUSPEND

DFHDSSRX [CALL,]

[CLEAR,]

[IN,

FUNCTION(SUSPEND),

PURGEABLE(YES|NO),

SUSPEND_TOKEN(name4 | (Rn)),

[INTERVAL(name4 | (Rn)),]

[RESOURCE_NAME(name16 | string | 'string'),]

[RESOURCE_TYPE(name8 | string | 'string'),]

[TIME_UNIT(SECOND|MILLI_SECOND),]

[WLM_WAIT_TYPE,]]

[OUT,

[COMPLETION_CODE(name1 | (Rn)),]

RESPONSE(name1 | *),

REASON(name1 | *)]

COMPLETION_CODE (name1 | (Rn))

returns a user-defined “reason for action” code during suspend and resume
processing.

name1

The name of a 1-byte area to receive the code. The value in this field is
user-defined, and is ignored by CICS.

(Rn)

A register in which the low-order byte contains the completion code and
the other bytes are zero.

INTERVAL(name4 | (Rn))

specifies in seconds or milliseconds the time after which the task is
automatically resumed and given a RESPONSE value of ‘PURGED’ and a
REASON value of ‘TIMED_OUT’. The time unit used on the INTERVAL option
depends on the setting of the TIME_UNIT option. The INTERVAL value
overrides any time-out (DTIMOUT) value specified for the transaction.

name4

The name of a 4-byte area, which is interpreted as a binary fullword.

dispatcher functions

304

CICS TS for OS/390: CICS Customization Guide

|

|

|
|

Advertising