 |
» |
|
|
|
The query_conversation command returns information about conversations
using a particular local LU. This command can be used to obtain
information about a specific conversation or a range of conversations,
depending on the options used. This command must be issued to a running node. Supplied Parameters | |
Parameter name Type Length Default
[query_conversation]
num_entries decimal 1
list_options constant SUMMARY+LIST_INCLUSIVE
conv_id hex number 4 0x00
lu_name character 8 (null string)
lu_alias character 8 (null string)
session_id hex array 8 (null array) |
Supplied parameters are: - num_entries
Maximum number of sessions for which data should
be returned. You can specify 1 to return data for a specific conversation,
a number greater than 1 to return data for multiple conversations,
or 0 to return data for all conversations. - list_options
The position in the list of conversations from which SNAplus2
begins to return data. Specify one of the following values: - FIRST_IN_LIST
Start at the first entry in the list. - LIST_INCLUSIVE
Start at the entry specified by the combination
of local LU, partner LU, and conversation ID. - LIST_FROM_NEXT
Start at the entry immediately following the entry specified
by the combination of local LU, partner LU, and conversation ID.
- conv_id
The identifier of the conversation for which information is
required, or the conversation ID to be used as an index into the
list of conversations. This parameter is ignored if list_options is set to FIRST_IN_LIST. - lu_name
LU name of the local LU. This name is a type-A character
string. To indicate that the LU is identified by its LU alias instead
of its LU name, do not specify this parameter. To specify the LU
associated with the local CP (the default LU), do not specify either lu_name or lu_alias. - lu_alias
Locally defined LU alias. This parameter is used
only if lu_name is not specified. To specify the LU associated with
the local CP (the default LU), do not specify either lu_name or lu_alias. - session_id
8-byte session identifier. To list only information
about conversations associated with a specific session, specify the
session identifier. To obtain a complete list for all sessions,
do not specify this parameter.
Returned Parameters | |
Parameter name Type Length
conv_id hex number 4
local_tp_name character 64
partner_tp_name character 64
tp_id hex array 8
sess_id hex array 8
conv_start_time decimal
bytes_sent decimal
bytes_received decimal
conv_state constant |
If the command executes successfully, SNAplus2 returns the
following parameters: - conv_id
Conversation identifier. The conversation ID was returned
by the ALLOCATE verb in the invoking TP,
or by the RECEIVE_ALLOCATE verb in the
invoked TP. - local_tp_name
The name of the local TP in the conversation. - partner_tp_name
The name of the partner TP in the conversation.
This parameter is returned only if the conversation was started
by the local TP; it is reserved if the conversation was started
by the remote TP. - tp_id
The TP identifier of the conversation. - sess_id
The session identifier of the session allocated
to the conversation. - conv_start_time
The elapsed time in hundreths of seconds between
the time when the SNAplus2 node was started and the time when the
conversation was started. - bytes_sent
The number of bytes that have been sent from the
local TP to the partner TP since the start of the conversation. - bytes_received
The number of bytes that have been received from
the partner TP by the local TP since the start of the conversation. - conv_state
The current state of the conversation. Values are:
Error Return Codes | |
If the command cannot be executed, SNAplus2 returns a primary
return code to indicate the type of error and a secondary return
code to provide specific details about the reason for unsuccessful
execution. If the command does not execute because of a parameter error,
SNAplus2 returns the following parameters: - primary_rc
PARAMETER_CHECK - secondary_rc
Possible values are: - AD_CONV_ID
The list_options parameter was set to LIST_INCLUSIVE to
list all entries starting from the supplied conversation ID, but
the conv_id parameter value was not valid. - INVALID_LU_ALIAS
The lu_alias parameter value was not valid. - INVALID_LU_NAME
The lu_name parameter value was not valid.
|
Printable version
