Reliable Transaction Router
System Manager's Manual
Previous Contents Index

CALL RTR_REPLY_TO_CLIENT

The CALL RTR_REPLY_TO_CLIENT command causes a command server to execute the rtr_reply_to_client() routine and to display the returned status.

Format

CALL RTR_REPLY_TO_CLIENT [message-field1] [,message-field2,...]

Parameters

[message-field1] [,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
/FORMAT[=fmt-string] /NOFORMAT
/INDEPENDENT NOINDEPENDENT
/LENGTH_OF_FIELD=msg length Depends on data type.
/NODE[=node-list] /NODE=default-node
/OUTPUT[=filespec] /OUTPUT=stdout
/TYPE_OF_DATA=data type /TYPE_OF_DATA=STRING

Description

The CALL RTR_REPLY_TO_CLIENT command causes a command server to call the rtr_reply_to_client() 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_reply_to_client() routine itself is described in the C Application Programmer's Reference Manual.

The prototype of rtr_reply_to_client() is: 


    rtr_status_t   rtr_reply_to_client ( 
                       rtr_channel_t       channel, 
                       rtr_rep_flag_t      flags, 
                       rtr_msgbuf_t        pmsg, 
                       rtr_msglen_t        msglen, 
                       rtr_msgfmt_t        msgfmt 
                       ) ;

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

Table 7-11 Parameters for rtr_reply_to_client
C Parameter Name C Parameter Value Command Line Specification
channel   /CHANNEL_NAME=name
flags RTR_NO_FLAGS none [D]
  RTR_F_REP_ACCEPT /ACCEPT
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 reply_to_client() . It means the transaction is accepted by this server.

/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.

/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 7-12 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 C Application Programmer's Reference Manual, section "Defining a Message Format Description" for information on constructing an fmt-string parameter.

/INDEPENDENT

NOINDEPENDENT

Use the /INDEPENDENT qualifier to specify the flags parameter RTR_F_ACC_INDEPENDENT in the call to rtr_reply_to_client() .

/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.

/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.

Related commands

Examples

The following example replies a message to the client. 

RTR>  CALL RTR_REPLY_TO_CLIENT "Getting that info for you"
 %RTR-S-OK, Normal successful completion

The following example shows a message of type unsigned and entered as a hexadecimal number. 


 RTR> CALL RTR_REPLY_TO_CLIENT "0xFA9BC0"/TYPE_OF_DATA=UNSIGNED
 %RTR-S-OK, Normal successful completion

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.

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 7-13 shows the correspondence between values you supply on the command line and the C language parameter values produced and used for the call.

Table 7-13 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.

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 7-14 shows the correspondence between values you supply on the command line and the C language parameter values produced and used for the call.

Table 7-14 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 7-15 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 C Application Programmer's Reference Manual, section "Defining a Message Format Description" for information on constructing an 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

Previous Next Contents Index