# hp Reliable Transaction Router
System Manager's Manual

Previous | Contents | Index

# CALL RTR_REQUEST_INFO

> The CALL RTR_REQUEST_INFO command causes a command server to execute the `rtr_request_info()` routine and to display the returned status.

> Note This command is not available in the RTR web browser interface.

## Format

> CALL RTR_REQUEST_INFO

Command Qualifiers | Defaults
--- | ---
/CHANNEL_NAME=channel-name | /CHANNEL_NAME=RTR$DEFAULT_CHANNEL
/CLUSTER | /NOCLUSTER
/GETITM=item-name | None
/INFCLA=infoclass | None
/NODE[=node-list] | /NODE=default-node
/OUTPUT[=filespec] | /OUTPUT=stdout
/SELITM=item-name | None
/SELVAL=item-value | None

## Description

> The CALL RTR_REQUEST_INFO command causes a command server to call the `rtr_request_info()` routine using values supplied on the command line.

> The `rtr_request_info()` routine itself is described in the C Application Programmer's Reference Manual.

> The prototype of `rtr_request_info()` is:

>             rtr_status_t    rtr_request_info (
>         rtr_channel_t       *pchannel,
>         rtr_req_flag_t      flags,
>         rtr_infoclass_t     infcla
>         rtr_itemcode_t      selitm
>         rtr_selval_t        selval
>         rtr_itemcode_t      getitms
>         ) ;

> Table 8-15 shows the correspondence between values you supply on the command line and the C language parameter values produced and used for the call.

> Table 8-15 Parameters for rtr_request_info
> C Parameter Name | Parameter Value | Command Line Specification
> --- | --- | ---
> *pchannel |  | /CHANNEL_NAME=name
> flags | RTR_NO_FLAGS | [none] [D]
> infcla | RTR_INFCLA_BACKEND_TX | /INFCLA=BTX
> selitm | fdb_f_name | /SELITM=fdb_f_name
> selval | CASHFACIL | /SELVAL=CASHFACIL
> getitms | fe_node_id | /GETITMS=fe_node_id

## Qualifiers

> ### /CHANNEL_NAME=channel_name

> ### /CHANNEL_NAME=RTR$DEFAULT_CHANNEL

> Specifies the channel for which the operation is to be performed.

> The command server uses a combination of the channel name and the window from which the call was issued to uniquely identify which channel to use.

> `channel_name` is not case sensitive.

> The default channel name is RTR$DEFAULT_CHANNEL.

> ### /CLUSTER

> ### /NOCLUSTER (D)

> Specifies that the command is executed on all the nodes in the cluster.

> If neither /NODE nor /CLUSTER is specified, the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT command has been entered, the command is executed only on the node where the command was issued.

> Note In environments that do not support remote command capability, the /CLUSTER qualifier causes the relevant command to be executed on the local node only. See Section 1.4 for more information.

> ### /GETITM=item-name[,item-name...]

> ### No default

> Specifies the `getitm` parameter in the `rtr_request_info()` call.

> ### /INFCLA=infoclass

> ### No default

> Specifies the `infcla` parameter in the `rtr_request_info()` call.

> ### /NODE[=node-list]

> ### /NODE=default-node (D)

> Specifies that the command is executed on all nodes specified in `node-list` . If `node-list` is omitted, the command is executed only on the node where the command was issued.

> ### /OUTPUT[=filespec]

> ### /OUTPUT=stdout (D)

> Specifies that the resulting information is written to the file `filespec` . If /OUTPUT or `filespec` is omitted, the standard or default output is used.

> ### /SELITM=item-name

> ### No default

> Specifies the `selitm` parameter in the `rtr_request_info()` call.

> ### /SELVAL=item-value

> ### No default

> Specifies the `selval` parameter in the `rtr_request_info()` call.

##

### Examples

> This command requests the backend transaction IDs for the facility CASHFAC.

     RTR> CALL RTR_REQUEST_INFO/CHANNEL=INFOCHAN
     /INFCLA="btx"/SELITM=fac_id/SELVAL=CASHFAC
     /GETITMS=tb_txdx.tx_id

> The information can then be viewed by repeatedly executing the following command until the channel is closed.

     RTR> CALL RTR_RECEIVE_MESSAGE/CHANNEL=INFOCHAN/TIMEOUT

# CALL RTR_SEND_TO_SERVER

> The CALL RTR_SEND_TO_SERVER command causes a command server to execute the `rtr_send_to_server()` routine and to display the returned status.

> Note This command is not available in the RTR web browser interface.

## Format

> CALL RTR_SEND_TO_SERVER [message-field1] [,message-field2,...]

## Parameters

> ### [message-field] [,message-field2,...]

> Specify the message to be sent as one or more comma-separated parameter values. You can use the /TYPE_OF_DATA and /LENGTH_OF_DATA positional qualifiers on each parameter value to specify the data type and length of each field.

Command Qualifiers | Defaults
--- | ---
/ACCEPT | /NOACCEPT
/CHANNEL_NAME=channel-name | /CHANNEL_NAME=RTR$DEFAULT_CHANNEL
/CLUSTER | /NOCLUSTER
/EXPENDABLE | /NOEXPENDABLE
/FORMAT[=fmt-string] | /NOFORMAT
/LENGTH_OF_FIELD=msg-length | Depends on data type.
/NODE[=node-list] | /NODE=default-node
/OUTPUT[=filespec] | /OUTPUT=stdout
/READONLY | /NOREADONLY
/RETURN_TO_SENDER | /NORETURN_TO_SENDER
/TYPE_OF_DATA=data type | /TYPE_OF_DATA=STRING

## Description

> The CALL RTR_SEND_TO_SERVER command causes a command server to call the `rtr_send_to_server()` routine using values supplied on the command line.

> The numeric status returned from the call is then converted to its textual representation and displayed.

> The `rtr_send_to_server()` routine itself is described in the C Application Programmer's Reference Manual.

> The prototype of `rtr_send_to_server()` is:

>         rtr_status_t   rtr_send_to_server (
>                            rtr_channel_t       channel,
>                            rtr_sen_flag_t      flags,
>                            rtr_msgbuf_t        pmsg,
>                            rtr_msglen_t        msglen,
>                            rtr_msgfmt_t        msgfmt
>                            ) ;

> Table 8-16 shows the correspondence between values you supply on the command line and the C language parameter values produced and used for the call.

> Table 8-16 Parameters for rtr_send_to_server
> C Parameter Name | C Parameter Value | Command Line Specification
> --- | --- | ---
> channel |  | /CHANNEL_NAME=name
> flags | RTR_NO_FLAGS | none [D]
> | RTR_F_SEN_EXPENDABLE | /EXPENDABLE
> | RTR_F_SEN_READONLY | /READONLY
> | RTR_F_SEN_RETURN_TO_SENDER | /RETURN_TO_SENDER
> pmsg, msglen, msgfmt 1 |  | [message definition parameter list with positional qualifiers ]

1 The actual values used for `pmsg`, `msglen` and `msgfmt` are based upon the message definition you specify as a command line parameter.

The command server uses message data specified as command line parameter values to generate a record containing the message data (for the `pmsg` parameter), the message length (for the `msglen` parameter), and a record type description (for the `msgfmt` parameter).

## Qualifiers

> ### /ACCEPT

> ### /NOACCEPT

> The /ACCEPT qualifier sets the flag RTR_F_REP_ACCEPT in the call to `send_to_server()` . It means the transaction is accepted by this client.

> ### /CHANNEL_NAME=channel_name

> ### /CHANNEL_NAME=RTR$DEFAULT_CHANNEL

> Specifies the channel for which the operation is to be performed.

> The command server uses a combination of the `channel_name` and the window from which the call was issued to uniquely identify which channel to use.

> `channel_name` is not case sensitive.

> The default channel name is RTR$DEFAULT_CHANNEL.

> ### /CLUSTER

> ### /NOCLUSTER (D)

> Specifies that the command is executed on all the nodes in the cluster.

> If neither /NODE nor /CLUSTER is specified, the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT command has been entered, the command is executed only on the node where the command was issued.

> Note In environments that do not support remote command capability, the /CLUSTER qualifier causes the relevant command to be executed on the local node only. See Section 1.4 for more information.

> ### /EXPENDABLE

> ### /NOEXPENDABLE

> The /EXPENDABLE qualifier sets the flag RTR_F_SEN_EXPENDABLE in the call `rtr_send_to_server()` .

> ### /FORMAT[=fmt-string]

> ### /NOFORMAT (D)

> Specifies that a format string should be sent with this message.

> If /FORMAT is specified without `fmt-string` , RTR automatically generates a format string. The format string is generated using the parameters given for the qualifiers /SIGNED, /UNSIGNED, /STRING and /LENGTH. The following table shows permitted values for these qualifiers when using /FORMAT without `fmt-string` .

> Table 8-17 Generated Format Strings
> Data Type | With /LENGTH= | With /NOLENGTH
> --- | --- | ---
> STRING | =n, "%nC" | "%nC" where n=strlen(string)
> SIGNED | =1, "%SB" | "%SL"
> SIGNED | =2, "%SW" | "%SL"
> SIGNED | =4, "%SL" | "%SL"
> UNSIGNED | =1, "%UB" | "%SL"
> UNSIGNED | =2, "%UW" | "%SL"
> UNSIGNED | =4, "%UL" | "%SL"

> Refer to the Reliable Transaction Router C Application Programmer's Reference Manual, section "Defining a Message Format Description" for information on constructing a `fmt-string` parameter.

> ### /LENGTH_OF_FIELD=field-length

> Enter the size of the message field that you want to define. The default for string types is the length of the message entered, plus one (for the zero termination byte). The default for signed and unsigned types is four. This is a positional qualifier; it must immediately follow the message field that it refers to.

> ### /NODE[=node-list]

> ### /NODE=default-node (D)

> Specifies that the command is executed on all nodes specified in `node-list` . If `node-list` is omitted, the command is executed only on the node where the command was issued.

> ### /OUTPUT[=filespec]

> ### /OUTPUT=stdout (D)

> Specifies that the resulting information is written to the file `filespec` . If /OUTPUT or `filespec` is omitted, the standard or default output is used.

> ### /READONLY

> ### /NOREADONLY

> The /READONLY qualifier sets the flag RTR_F_SEN_READONLY in the call `rtr_send_to_server()` . No entry is made in the journal file.

> ### /RETURN_TO_SENDER

> ### /NORETURN_TO_SENDER

> The /RETURN_TO_SENDER qualifier sets the flag
> RTR_F_SEN_RETURN_TO_SENDER in the call `rtr_send_to_server()` .

> ### /TYPE_OF_DATA=STRING|SIGNED|UNSIGNED

> ### /TYPE_OF_DATA=STRING (D)

> Enter the data type of the message field that you want to define. The default is the string type. This is a positional qualifier; it must immediately follow the message field that it refers to.

##

### Examples

> This command sends a message to a server. The message is type string (the default).

         RTR>  CALL RTR_SEND_TO_SERVER "Get that info for me, please"
         %RTR-S-OK, Normal successful completion

# CALL RTR_SET_USER_CONTEXT

> The CALL RTR_SET_USER_CONTEXT command causes a command server to execute the `rtr_set_user_context()` routine and to display the returned value.

## Format

> CALL RTR_SET_USER_CONTEXT

Command Qualifiers | Defaults
--- | ---
/CHANNEL_NAME=channel-name | /CHANNEL_NAME=RTR$DEFAULT_CHANNEL
/CONTEXT=value | /CONTEXT=0
/NODE[=node-list] | /NODE=default-node
/OUTPUT[=filespec] | /OUTPUT=stdout

## Description

> The CALL RTR_SET_USER_CONTEXT command causes a command server to call the `rtr_set_user_context()` routine using values supplied on the command line.

> The `rtr_set_user_context()` routine itself is described in the Reliable Transaction Router C Application Programmer's Reference Manual.

> The prototype of `rtr_set_user_context()` is:

>         rtr_status_t rtr_set_user_context   (
>                       rtr_channel_t     chan,
>                       rtr_usrctx_t      usrctx
>                       ) ;

> Table 8-18 shows the correspondence between values you supply on the command line and the C language parameter values produced and used for the call.

> Table 8-18 Parameters for rtr_set_user_context
> C parameter name | C parameter value | command line specification
> --- | --- | ---
> channel |  | /CHANNEL_NAME=name
> usrctx | 457 | /CONTEXT=457

## Qualifiers

> ### /CHANNEL_NAME=channel_name

> ### /CHANNEL_NAME=RTR$DEFAULT_CHANNEL

> Specifies the channel for which the operation is to be performed.

> The command server uses a combination of the channel_name and the window from which the call was issued to uniquely identify which channel to use.

> `channel_name` is not case sensitive.

> The default channel name is RTR$DEFAULT_CHANNEL.

> ### /CONTEXT=value

> User context number associated with the current channel. Enter any numeric value.

> ### /NODE[=node-list]

> ### /NODE=default-node (D)

> Specifies that the command is executed on all nodes specified in `node-list` . If `node-list` is omitted, the command is executed only on the node where the command was issued.

> ### /OUTPUT[=filespec]

> ### /OUTPUT=stdout (D)

> Specifies that the resulting information is written to the file `filespec` . If /OUTPUT or `filespec` is omitted, the standard or default output is used.

##

### Examples

> The following command sets a user context of 567 for RTR$DEFAULT_CHANNEL.

         RTR> CALL RTR_SET_USER_CONTEXT /CONTEXT=567
         %RTR-S-OK, Normal successful completion

# CALL RTR_START_TX

> The CALL RTR_START_TX command causes a command server to execute the `rtr_start_tx()` routine and to display the returned status.

> Note This command is not available in the RTR web browser interface.

## Format

> CALL RTR_START_TX

Command Qualifiers | Defaults
--- | ---
/CHANNEL_NAME=channel-name | /CHANNEL_NAME=RTR$DEFAULT_CHANNEL
/CLUSTER | /NOCLUSTER
/JOIN_TXID=txid-number | /NOJOIN_TXID
/NODE[=node-list] | /NODE=default-node
/OUTPUT[=filespec] | /OUTPUT=stdout
/TIMEOUT_MS=timoutms | /TIMEOUT_MS=0
/TXID_TYPE=txid-type | /TXID_TYPE=RTR

## Description

> The CALL RTR_START_TX command causes a command server to call the `rtr_start_tx()` routine using values supplied on the command line.

> The numeric status returned from the call is then converted to its textual representation and displayed.

> The `rtr_start_tx()` routine itself is described in the Reliable Transaction Router C Application Programmer's Reference Manual.

> The prototype of `rtr_start_tx()` is:

>         rtr_status_t   rtr_start_tx (
>                            rtr_channel_t       channel,
>                            rtr_sta_flag_t      flags,
>                            rtr_timout_t        timoutms,
>                            rtr_channel_t       joinchan
>                            ) ;

> Table 8-19 shows the correspondence between values you supply on the command line and the C language parameter values produced and used for the call.

> Table 8-19 Parameters for rtr_start_tx
> C Parameter Name | C Parameter Value | Command Line Specification
> --- | --- | ---
> channel |  | /CHANNEL_NAME=name
> flags | RTR_NO_FLAGS | [none] [D]
> timoutms |  | /TIMEOUT_MS=timoutms
> joinchan |  | /JOIN_CHANNEL=channel-name

## Qualifiers

> ### /CHANNEL_NAME=channel_name

> ### /CHANNEL_NAME=RTR$DEFAULT_CHANNEL

> Specifies the channel for which the operation is to be performed.

> The command server uses a combination of the channel name and the window from which the call was issued to uniquely identify which channel to use.

> `channel_name` is not case sensitive.

> The default channel name is RTR$DEFAULT_CHANNEL.

> ### /CLUSTER

> ### /NOCLUSTER (D)

> Specifies that the command is executed on all the nodes in the cluster.

> If neither /NODE nor /CLUSTER is specified, the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT command has been entered, the command is executed only on the node where the command was issued.

> Note In environments that do not support remote command capability, the /CLUSTER qualifier causes the relevant command to be executed on the local node only. See Section 1.4 for more information.

> ### /JOIN_TXID=txid-number

> ### /NOJOIN_TXID

> The format of the txid-number depends on the TXID_TYPE:

>     TXID_TYPE          Format of txid-number
>     -----------------------------------------------------------
>     RTR                7 integers of 4 bytes each, separated by commas
>     DDTM               4 integers of 4 bytes each, separated by commas
>     XA                 Character-string up to 128 bytes of length

> ### /NODE[=node-list]

> ### /NODE=default-node (D)

> Specifies that the command is executed on all nodes specified in `node-list` . If `node-list` is omitted, the command is executed only on the node where the command was issued.

> ### /OUTPUT[=filespec]

> ### /OUTPUT=stdout (D)

> Specifies that the resulting information is written to the file `filespec` . If /OUTPUT or `filespec` is omitted, the standard or default output is used.

> ### /TIMEOUT_MS=timoutms

> ### /TIMEOUT_MS=0 (D)

> The `timoutms` argument defines a timeout for the transaction, in milliseconds. If the /TIMEOUT_MS qualifier is not used, the timeout value is infinite (no timeout); if the /TIMEOUT_MS qualifier is used with no value (e.g., /TIME), the timeout is immediate (time out right away if there is no message to receive).

> The granularity of the underlying timer is 1 second. Fractional values of the `timoutms` argument are rounded up to the next whole second. A value of 0 causes an immediate timeout.

> ### /TXID_TYPE=txid-type

> ### /TXID_TYPE=RTR (D)

> Possible values for TXID_TYPE parameter are RTR, DDTM and XA.

### Related commands

- CALL RTR_REJECT_TX
- CALL RTR_ACCEPT_TX

##

### Examples

> This command starts a new transaction with a timeout of 5000 milliseconds.

         RTR>  CALL RTR_START_TX /TIMEOUT_MS=5000
         %RTR-S-OK, Normal successful completion

Previous | Next | Contents | Index