RRMS domain's specific gates

Table 88 summarizes the RX domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gate, the functions provided by the gate, and whether or not the functions are available through the exit programming interface (XPI).

Table 88. RX domain’s specific gate
Gate Trace Function XPI
RXDM
RX 0101
RX 0102
INQUIRE_RRS SET_PARAMETERS
NO
NO
RXUW
RX 0401
RX 0402
PUT_CLIENT_REQUEST
GET_CLIENT_REQUEST
INQUIRE
NO
NO
NO

RXDM gate, INQUIRE_RRS function

The INQUIRE_RRS function of the RXDM gate is used to determine the status of CICS®'s interface with OS/390® Recoverable Resource Management Services (RRMS).

Output Parameters

OPEN
Returns YES or NO to indicate if the interface with RRMS is open.
[RESTART_STATE]
Returns a value to indicate the state of restart processing with Resource Recovery Services (RRS). One of these values is returned:
NOT_STARTED
Restart processing has not started
STARTING
Restart is in progress
COLD
Restart processing is complete, and RRS was cold started.
WARM
Restart processing is complete, and RRS was warm started.
RESPONSE
is the domain's response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RXDM gate, SET_PARAMETERS function

The SET_PARAMETERS function of the RXDM gate is used to pass the values of relevant System Initialization parameters to the domain.

Input Parameters

RRMS
Specifies the value of the RRMS System Initialization Parameter. It can have one of these values:
YES|NO

Output Parameters

RESPONSE
is the domain's response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|
KERNERROR|PURGED

RXUW gate, PUT_CLIENT_REQUEST function

The PUT_CLIENT_REQUEST function of the RXDM gate is used to associate a request from a client with an RRS Unit of Recovery (UR).

Input parameters

TRANSACTION_ID
The transaction id associated with the request. This parmeter is used to correlate succesive requests for the same transaction instance.
USERID
The userid associated with the request. This parmeter is used to correlate succesive requests for the same transaction instance.
CONNECTION
The connection on which the client request was received. This parameter is used to identify the source of the request in any messages that are issued.
CONTEXT_TOKEN
The token representing the RRMS context for which the request is issued.
URID
The identifier of the RRS Unit of Recovery associated with the context.
PASS_TOKEN
A token used to protect against unauthorised use of the context token and URID.
CLIENT_TOKEN
A token representing the client of the UR.
CLIENT_TYPE
Indicates the type of client of the transaction. The only permissible value is TERMINAL

Output parameters

NEW_UR
Indicates whether a new UR has been created for this request. It can have one of these values:
YES
indicates that a new UR has been created
Start of changeNO_AND_READYEnd of change
Start of changeindicates that the request was associated with an existing UR and that task is ready to receive the request.End of change
Start of changeNO_AND_NOT_READYEnd of change
Start of changeindicates that the request was associated with an existing UR but that task is not ready to receive the request. This usually occurs when the original request has timed out and another transactional EXCI request in the same RRS UR has been sent by the EXCI job.End of change
Start of changeNO_AND_NOTASKEnd of change
Start of changeindicates that the request was associated with an existing UR but that task has not yet expressed an interest in the UR. This can occur when the original request has been held by MAXTASK or TRANCLASS (TCLASS) limits and has timed out, and another Transactional EXCI request in the same UR has been sent by the EXCI job.End of change
UR_TOKEN
is the token by which the UR associated with the request is known by the RX domain.
TRANSACTION_NUMBER
The transaction number of the transaction associated with the request.
RESPONSE
is the domain's response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|
KERNERROR|PURGED

RXUW gate, GET_CLIENT_REQUEST function

The GET_CLIENT_REQUEST function of the RXDM gate is used to suspend a transaction until the PUT_CLIENT_REQUEST is issued for the same Unit of Recovery.

Input parameters

UR_TOKEN
is the token by which the UR associated with the request is known by the RX domain.
[TIMEOUT]
The time (in seconds) for which the transaction should be suspended. If this paramter is omitted, the transaction will be suspended indefinitely.

Output paramters

CLIENT_TOKEN
A token representing the client of the UR.
CLIENT_TYPE
Indicates the type of client of the transaction. The only possible value is TERMINAL
RESPONSE
is the domain's response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are
SYNCPOINT
RRS has requested a syncpoint
BACKOUT
RRS has requested rollback
RACE
RRS has requested syncpoint or rollback and a client request has been received at the same time
[REASON] is also returned when RESPONSE is PURGED. Possible values are
TASK_CANCELLED
The task has been purged
TIMED_OUT
The request has timed out

RXUW gate, INQUIRE function

The INQUIRE function requests attributes of a Unit of Recovery

Input parameters

UR_TOKEN
is the token which identifies the Unit of Recovery

Output parameters

[URID]
The identifier of the Unit of Recovery used by RRMS.
RESPONSE
is the domain's response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|
KERNERROR|PURGED
[[ Contents Previous Page | Next Page Index ]]