 |
» |
|
|
|
QUERY_COS_NODE_ROW returns node row information for a specified class
of service as previously defined by DEFINE_COS (or implicitly by the
node for the SNA-defined COSs). This verb can be used to obtain information about a specific
COS node row, or about multiple COS node rows, depending on the
options used. VCB
Structure | |
typedef struct query_cos_node_row
{
AP_UINT16 opcode; /* verb operation code */
unsigned char reserv2; /* reserved */
unsigned char format; /* reserved */
AP_UINT16 primary_rc; /* primary return code */
AP_UINT32 secondary_rc; /* secondary return code */
unsigned char *buf_ptr; /* pointer to buffer */
AP_UINT32 buf_size; /* buffer size */
AP_UINT32 total_buf_size; /* total buffer size required */
AP_UINT16 num_entries; /* number of entries */
AP_UINT16 total_num_entries; /* total number of entries */
unsigned char list_options; /* listing options */
unsigned char reserv3; /* reserved */
unsigned char cos_name[8]; /* cos name */
AP_UINT16 node_row_index; /* node row index */
} QUERY_COS_NODE_ROW;
|
typedef struct cos_node_row_data
{
AP_UINT16 overlay_size; /* size of returned entry */
unsigned char cos_name[8]; /* cos name */
AP_UINT16 node_row_index; /* node row index */
COS_NODE_ROW node_row; /* cos node row information */
} COS_NODE_ROW_DATA;
|
typedef struct cos_node_row
{
COS_NODE_STATUS minimum; /* minimum */
COS_NODE_STATUS maximum; /* maximum */
unsigned char weight; /* weight */
unsigned char reserv1; /* reserved */
} COS_NODE_ROW;
|
typedef struct cos_node_status
{
unsigned char rar; /* route additional resistance */
unsigned char status; /* node status */
unsigned char reserv1[2]; /* reserved */
} COS_NODE_STATUS;
|
Supplied
Parameters | |
The application supplies the following parameters: - opcode
AP_QUERY_COS_NODE_ROW - overlay_size
For compatability with future releases of SNAplus2, your
application must use this field to determine the exact length of
the overlay structure returned, and should not rely on the use of
the sizeof() function. - buf_ptr
A pointer to a data buffer that SNAplus2 will use
to return the requested information. - buf_size
Size of the supplied data buffer. - num_entries
Maximum number of COS node rows for which data should
be returned. To request data for a specific COS node row rather
than a range, specify the value 1. To return
as many entries as possible, specify zero; in this case, SNAplus2
will return the maximum number of entries that can be accommodated
in the supplied data buffer. - list_options
The position in the list of COS node rows from which SNAplus2
should begin to return data. Possible values are: - AP_FIRST_IN_LIST
Start at the first entry in the list. - AP_LIST_INCLUSIVE
Start at the entry specified by the combination
of the cos_name and node_row_index parameters. - AP_LIST_FROM_NEXT
Start at the entry immediately following the entry
specified by the combination of the cos_name and node_row_index parameters.
The list is ordered by cos_name, and then by node_row_index for each COS. For more information about how the application
can obtain specific entries from the list, see “List
Options For QUERY_* Verbs”. - cos_name
Class of service name for which node row information is
required, or the name to be used as an index into the list. This
value is ignored if list_options is set to AP_FIRST_IN_LIST.
The name is an 8-byte type-A EBCDIC string (starting with a letter),
padded on the right with EBCDIC spaces if the name is shorter than 8
characters. - node_row_index
Node row number for which information is required,
or the number to be used as an index into the list. This value is
ignored if list_options is set to AP_FIRST_IN_LIST.
Use QUERY_COS to determine the number of node rows associated with
this COS.
Returned
Parameters: Successful Execution | |
If the verb executes successfully, SNAplus2 returns the following parameters: - primary_rc
AP_OK - buf_size
Length of the information returned in the supplied buffer. - total_buf_size
Returned value indicating the size of buffer that
would have been required to return all the list information requested.
A value greater than buf_size indicates that not all the available entries were returned. - num_entries
Number of entries returned in the data buffer. - total_num_entries
Total number of entries available. A value greater
than num_entries indicates that not all the available entries were returned. Each entry in the data buffer consists of the following parameters: - cos_node_row_data.overlay_size
The size of the returned cos_node_row_data structure, and therefore the offset to the start of the next
entry in the data buffer. - cos_node_row_data.cos_name
Class of service name. This is an 8-byte type-A EBCDIC
string (starting with a letter), padded on the right with EBCDIC
spaces if the name is shorter than 8 characters. - cos_node_row_data.node_row_index
Node row index. - cos_node_row_data.node_row.minimum.rar
Route additional resistance minimum, in the range 0-255. - cos_node_row_data.node_row.minimum.status
Specifies the minimum congestion status of the node. This
parameter may be set to AP_UNCONGESTED,
to any one of the other values listed, or to two or more of the other
values combined using a logical OR. Possible values
are: - AP_UNCONGESTED
The number of ISR sessions is below the isr_sessions_upper_threshold value in the node's configuration. - AP_CONGESTED
The number of ISR sessions exceeds the threshold
value. - AP_IRR_DEPLETED
The number of ISR sessions has reached the maximum
specified for the node. - AP_ERR_DEPLETED
The number of endpoint sessions has reached the
maximum specified. - AP_QUIESCING
A STOP_NODE of type AP_QUIESCE or AP_QUIESCE_ISR has
been issued.
- cos_node_row_data.node_row.maximum.rar
Route additional resistance maximum, in the range 0-255. - cos_node_row_data.node_row.maximum.status
Specifies the maximum congestion status of the node. This
parameter may be set to AP_UNCONGESTED,
to any one of the other values listed, or to two or more of the other
values combined using a logical OR. Possible values
are: - AP_UNCONGESTED
The number of ISR sessions is below the isr_sessions_upper_threshold value in the node's configuration. - AP_CONGESTED
The number of ISR sessions exceeds the threshold
value. - AP_IRR_DEPLETED
The number of ISR sessions has reached the maximum
specified for the node. - AP_ERR_DEPLETED
The number of endpoint sessions has reached the
maximum specified. - AP_QUIESCING
A STOP_NODE of type AP_QUIESCE or AP_QUIESCE_ISR has
been issued.
- cos_node_row_data.node_row.weight
Weight associated with this node row.
Returned
Parameters: Parameter Check | |
If the verb does not execute because of a parameter error,
SNAplus2 returns the following parameters: - primary_rc
AP_PARAMETER_CHECK - secondary_rc
Possible values are: - AP_INVALID_COS_NAME
The list_options parameter was set to AP_LIST_INCLUSIVE,
to list all entries starting from the supplied name, but the cos_name parameter was not valid. - AP_INVALID_LIST_OPTION
The list_options parameter was not set to a valid value.
Appendix A “Common
Return Codes” lists further
secondary return codes associated with AP_PARAMETER_CHECK,
which are common to all NOF verbs. Returned
Parameters: Other Conditions | |
Appendix A “Common
Return Codes” lists further
combinations of primary and secondary return codes that are common
to all NOF verbs. |
Printable version
