 |
» |
|
|
|
QUERY_COS_TG_ROW returns TG 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 TG row, or about multiple COS TG rows, depending on the options
used. VCB
Structure | |
typedef struct query_cos_tg_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 tg_row_index; /* TG row index */
} QUERY_COS_TG_ROW;
|
typedef struct cos_tg_row_data
{
AP_UINT16 overlay_size; /* size of returned entry */
unsigned char cos_name[8]; /* cos name */
AP_UINT16 tg_row_index; /* TG row index */
COS_TG_ROW tg_row; /* TG row information */
} COS_TG_ROW_DATA;
|
typedef struct cos_tg_row
{
TG_DEFINED_CHARS minimum; /* minimum */
TG_DEFINED_CHARS maximum; /* maximum */
unsigned char weight; /* weight */
unsigned char reserv1; /* reserved */
} COS_TG_ROW;
|
typedef struct tg_defined_chars
{
unsigned char effect_cap; /* Effective capacity */
unsigned char reserve1[5]; /* Reserved */
unsigned char connect_cost; /* Connection Cost */
unsigned char byte_cost; /* Byte cost */
unsigned char reserve2; /* Reserved */
unsigned char security; /* Security */
unsigned char prop_delay; /* Propagation delay */
unsigned char modem_class; /* reserved */
unsigned char user_def_parm_1; /* User-defined parameter 1 */
unsigned char user_def_parm_2; /* User-defined parameter 2 */
unsigned char user_def_parm_3; /* User-defined parameter 3 */
} TG_DEFINED_CHARS;
|
Supplied
Parameters | |
The application supplies the following parameters: - opcode
AP_QUERY_COS_TG_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 TG rows for which data should
be returned. To request data for a specific COS TG 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 TG 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 tg_row_index parameters. - AP_LIST_FROM_NEXT
Start at the entry immediately following the entry
specified by the combination of the cos_name and tg_row_index parameters.
The list is ordered by cos_name, and then by tg_row_index for each COS. For more information about how the list
is ordered and how the application can obtain specific entries from
it, see “List
Options For QUERY_* Verbs”. - cos_name
Class of service name for which data is required,
or the name to be used as an index into the 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.
This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. - tg_row_index
TG row number for which data is required, or the number
to be used as an index into the list (the first row has an index
of zero). This parameter is ignored if list_options is set to AP_FIRST_IN_LIST.
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_tg_row_data.overlay_size
The size of the returned cos_tg_row_data structure, and therefore the offset to the start of the
next entry in the data buffer. - cos_tg_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_tg_row_data.tg_row_index
TG row index (the first row has an index of zero). - cos_tg_row_data.tg_row.minimum.effect_cap
Minimum limit for actual bits per second rate (line speed).
The value is encoded as a 1-byte floating point number, represented
by the formula 0.1 mmm * 2 eeeee where
the bit representation of the byte is b'eeeeemmm'. Each unit of
effective capacity is equal to 300 bits per second. - cos_tg_row_data.tg_row.minimum.connect_cost
Minimum limit for cost per connect time; an integer value
in the range 0-255,
where 0 is the lowest cost per connect
time and 255 is the highest. - cos_tg_row_data.tg_row.minimum.byte_cost
Minimum limit for cost per byte; an integer value
in the range 0-255,
where zero is the lowest cost per byte and 255 is
the highest. - cos_tg_row_data.tg_row.minimum.security
Minimum level of security. Possible values are: - AP_SEC_NONSECURE
No security. - AP_SEC_PUBLIC_SWITCHED_NETWORK
Data is transmitted over a public switched network. - AP_SEC_UNDERGROUND_CABLE
Data is transmitted over secure underground cable. - AP_SEC_SECURE_CONDUIT
Data is transmitted over a line in a secure conduit
that is not guarded. - AP_SEC_GUARDED_CONDUIT
Data is transmitted over a line in a conduit that
is protected against physical tapping. - AP_SEC_ENCRYPTED
Data is encrypted before transmission over the line. - AP_SEC_GUARDED_RADIATION
Data is transmitted over a line that is protected
against physical and radiation tapping.
- cos_tg_row_data.tg_row.minimum.prop_delay
Minimum limits for propagation delay: the time that
a signal takes to travel the length of the link. Possible values
are: - AP_PROP_DELAY_MINIMUM
Minimum propagation delay. - AP_PROP_DELAY_LAN
Delay is less than 480 microseconds (typical for
a LAN). If the verb was issued to a running node, this value will
be returned if the DEFINE_COS specified either AP_PROP_DELAY_LAN or AP_PROP_DELAY_MINIMUM. - AP_PROP_DELAY_TELEPHONE
Delay is in the range 480-49,512 microseconds (typical
for a telephone network). - AP_PROP_DELAY_PKT_SWITCHED_NET
Delay is in the range 49,512-245,760 microseconds
(typical for a packet-switched network). - AP_PROP_DELAY_SATELLITE
Delay is greater than 245,760 microseconds (typical
for a satellite link). - AP_PROP_DELAY_MAXIMUM
Maximum propagation delay.
- cos_tg_row_data.tg_row.minimum.user_def_parm_1 through cos_tg_row_data.tg_row.minimum.user_def_parm_3
Minimum values for user-defined parameters, which include
other TG characteristics not covered by the above parameters. Each
of these parameters is set to a value in the range 0-255. - cos_tg_row_data.tg_row.maximum.effect_cap
Maximum limit for actual bits per second rate (line speed).
The value is encoded as a 1-byte floating point number, represented
by the formula 0.1 mmm * 2 eeeee where
the bit representation of the byte is eeeeemmm. Each unit of effective
capacity is equal to 300 bits per second. - cos_tg_row_data.tg_row.maximum.connect_cost
Maximum limit for cost per connect time; an integer value
in the range 0-255,
where 0 is the lowest cost per connect
time and 255 is the highest. - cos_tg_row_data.tg_row.maximum.byte_cost
Maximum limit for cost per byte; an integer value
in the range 0-255,
where 0 is the lowest cost per byte and 255 is
the highest. - cos_tg_row_data.tg_row.maximum.security
Maximum level of security. Possible values are: - AP_SEC_NONSECURE
No security. - AP_SEC_PUBLIC_SWITCHED_NETWORK
Data is transmitted over a public switched network. - AP_SEC_UNDERGROUND_CABLE
Data is transmitted over secure underground cable. - AP_SEC_SECURE_CONDUIT
Data is transmitted over a line in a secure conduit
that is not guarded. - AP_SEC_GUARDED_CONDUIT
Data is transmitted over a line in a conduit that
is protected against physical tapping. - AP_SEC_ENCRYPTED
Data is encrypted before transmission over the line. - AP_SEC_GUARDED_RADIATION
Data is transmitted over a line that is protected
against physical and radiation tapping. - AP_SEC_MAXIMUM
Maximum security.
- cos_tg_row_data.tg_row.maximum.prop_delay
Maximum limits for propagation delay: the time that
a signal takes to travel the length of the link. Possible values
are: - AP_PROP_DELAY_MINIMUM
Minimum propagation delay. - AP_PROP_DELAY_LAN
Delay is less than 480 microseconds (typical for
a LAN). - AP_PROP_DELAY_TELEPHONE
Delay is in the range 480-49,512 microseconds (typical
for a telephone network). - AP_PROP_DELAY_PKT_SWITCHED_NET
Delay is in the range 49,512-245,760 microseconds
(typical for a packet-switched network). - AP_PROP_DELAY_SATELLITE
Delay is greater than 245,760 microseconds (typical
for a satellite link). If the verb was issued to a running node,
this value will be returned if the DEFINE_COS specified either AP_PROP_DELAY_SATELLITE or AP_PROP_DELAY_MAXIMUM. - AP_PROP_DELAY_MAXIMUM
Maximum propagation delay.
- cos_tg_row_data.tg_row.maximum.user_def_parm_1 through cos_tg_row_data.tg_row.maximum.user_def_parm_3
Maximum values for user-defined parameters, which include
other TG characteristics not covered by the above parameters. Each
of these parameters is set to a value in the range 0-255. - cos_tg_row_data.tg_row.weight
Weight associated with this TG 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
