Resume output for the hold queue for tpipe
The state data for resume output for the hold queue for tpipe portion of the OTMA message prefix is mapped by the TMAMHDR DSECT of the DFSYMSG macro.
An OTMA client sends the command to inform IMS to deliver one or all queued messages on
the hold queue for tpipe. If this command is not issued, messages
are held in the hold queue. However, the option that is specified
in the command can be used to request how IMS holds
and delivers messages. One of the four options in the following table
can be specified in the State Data. If the client or z/OS®
cross-system coupling facility returns
a NAK message to IMS, the current
option is reset to No-Auto, which is the default.
The following table summarizes the format of state data for Resume Output for the hold queue tpipe. The summary includes, as appropriate, byte, length, content, hexadecimal value, and the description.
| Byte | Length | Content | Value | Description |
|---|---|---|---|---|
| 0 | 2 | Length | Length of the state-data section. | |
| 2 | 1 | Delivery option | X'00' | No-Auto: exhaust all the messages in the queue only when the command is issued. This is the default. |
| X'01' | One Only: deliver one message in the queue when the command is issued. | |||
| X'02' | Auto: exhaust all the messages in the queue. After that, automatically deliver messages when they are queued. | |||
| X'04' | Auto-One: deliver one message automatically when a message is available in
the queue. The message might already be in the queue or it might be delivered later. After the
message is delivered, this option is reset to No-Auto. |
|||
| 3 | 1 | Callout mode | X'80' | RESUME TPIPE call retrieves callout messages with a correlator token. |
| X'40' | RESUME TPIPE call retrieves both synchronous callout messages and asynchronous messages. | |||
| X'20' | RESUME TPIPE call supports control data. | |||
| X'10' |
RESUME TPIPE call supports network security credentials. |
|||
| 4 | 8 | Resume tpipe token | OTMA clients, such as IMS Connect, generate
a resume tpipe token to uniquely identify RESUME TPIPE requests. When a tpipe supports multiple active RESUME TPIPE requests (MULTIRTP=Y) from IMS Connect, you can display the resume tpipe token with its associated alternate client ID by issuing the /DISPLAY TMEMBER(tmemname) TPIPE(tpipename) command. The token is also used when the client cancels a resume tpipe request. |