QUERY_DLUR_LU

QUERY_DLUR_LU returns a list of information about DLUR-supported LUs.

The information is returned as a list in one of two formats, either summary or detailed information. To obtain information about a specific LU, or to obtain the list information in several chunks, the lu_name field should be set.

Otherwise (if the list_options field is set to AP_FIRST_IN_LIST), this field will be ignored. See Querying the Node for background on how the list formats are used.

This list is ordered by the lu_name. Ordering is by name length first, and then by ASCII lexicographical ordering for names of the same length (in accordance with normal MIB ordering).

If AP_LIST_FROM_NEXT is selected, the returned list starts from the next entry according to the defined ordering (whether the specified entry exists or not).

The list of LUs returned can be filtered by pu_name or by whether the LU is local or downstream or by both. If filtering by PU is desired, the pu_name field should be set (otherwise this field should be set to all zeros). If filtering by location is desired, the filter field should be set to AP_INTERNAL or AP_DOWNSTREAM (otherwise, if no filtering is required, this field should be set to AP_NONE).

VCB Structure

typedef struct query_dlur_lu
{
        unsigned short  opcode;            /* verb operation code         */
        unsigned char   reserv2;           /* reserved                    */
        unsigned char   format;            /* format                      */
        unsigned short  primary_rc;        /* primary return code         */
        unsigned long   secondary_rc;      /* secondary return code       */
        unsigned char   *buf_ptr;          /* pointer to buffer           */
        unsigned long   buf_size;          /* buffer size                 */
        unsigned long   total_buf_size;    /* total buffer size required  */
        unsigned short  num_entries;       /* number of entries           */
        unsigned short  total_num_entries; /* total number of entries     */
        unsigned char   list_options;      /* listing options             */
        unsigned char   reserv3;           /* reserved                    */
        unsigned char   lu_name[8];        /* name of LU                  */
        unsigned char   pu_name[8];        /* name of PU to filter on     */
        unsigned char   filter;            /* reserved                    */
} QUERY_DLUR_LU;
typedef struct dlur_lu_summary
{
        unsigned short  overlay_size;      /* size of this entry          */
        unsigned char   lu_name[8];        /* name of LU                  */
} DLUR_LU_SUMMARY;
typedef struct dlur_lu_detail
{
        unsigned short  overlay_size;      /* size of this entry          */
        unsigned char   lu_name[8];        /* name of LU                  */
        unsigned char   pu_name[8];        /* name of owning PU           */
        unsigned char   dlus_name[17];     /* DLUS name if SSCP-LU        */
                                           /* session active              */
        unsigned char   lu_location;       /* downstream or local LU      */
        unsigned char   nau_address;       /* NAU address of LU           */
        unsigned char   plu_name[17];      /* PLU name if PLU-SLU session */
                                           /* active                      */
        unsigned char   reserv1[27];       /* reserved                    */
        unsigned char   rscv_len;          /* length of appended RSCV     */
} DLUR_LU_DETAIL;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_QUERY_DLUR_LU
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
buf_ptr
Pointer to a buffer into which list information can be written. The application can append data to the end of the VCB, in which case buf_ptr must be set to NULL.
buf_size
Size of buffer supplied. The data returned will not exceed this size.
num_entries
Maximum number of entries to return. The number of entries will not exceed this value. A value of zero means no limit.
list_options
This indicates what should be returned in the list information:
AP_SUMMARY
Returns summary information only.
AP_DETAIL
Returns detailed information.

The lu_name specified (see the following parameter, lu_name) represents an index value that is used to specify the starting point of the actual information to be returned.

AP_FIRST_IN_LIST
The index value is ignored, and the returned list starts from the first entry in the list.
AP_LIST_FROM_NEXT
The returned list starts from the next entry in the list after the one specified by the supplied index value.
AP_LIST_INCLUSIVE
The returned list starts from the entry specified by the index value.
lu_name
Name of LU being queried. This is an 8-byte alphanumeric type A EBCDIC string (starting with a letter), padded to the right with EBCDIC spaces. This field is ignored if list_options is set to AP_FIRST_IN_LIST.
pu_name
PU name filter. This should be set to all zeros or an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded to the right with EBCDIC spaces. If this field is set then only LUs associated with the specified PU are returned. This field is ignored if it is set to all zeros.
filter
Location filter. Specifies whether the returned LUs should be filtered by location (AP_INTERNAL or AP_DOWNSTREAM). If no filter is required, this field should be set to AP_NONE.

Returned Parameters

If the verb executes successfully, the Program returns the following parameters:
primary_rc
AP_OK
buf_size
Length of the information returned in the buffer.
total_buf_size
Returned value indicating the size of buffer that would have been required to return all the list information requested. This can be higher than buf_size.
num_entries
Number of entries actually returned.
total_num_entries
Total number of entries that could have been returned. This can be higher than num_entries.
dlur_lu_summary.overlay_size
The number of bytes in this entry, and hence the offset to the next entry returned (if any).
dlur_lu_summary.lu_name
Name of LU. This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded to the right with EBCDIC spaces.
dlur_lu_detail.overlay_size
The number of bytes in this entry (including appended RSCV), and hence the offset to the next entry returned (if any).
dlur_lu_detail.lu_name
Name of LU. This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded to the right with EBCDIC spaces.
dlur_lu_detail.pu_name
Name of PU associated with the LU. This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded to the right with EBCDIC spaces.
dlur_lu_detail.dlus_name
Name of the DLUS node if the SSCP-LU session is active. This is a 17-byte string composed of two type-A EBCDIC character strings concatenated by an EBCDIC dot, and is right-padded with EBCDIC spaces. (Each name can have a maximum length of 8 bytes with no embedded spaces.) If the SSCP-LU session is not active, this field will be set to all zeros.
dlur_lu_detail.lu_location
Location of LU. The only value returned is:

AP_INTERNAL
AP_DOWNSTREAM

dlur_lu_detail.nau_address
Network addressable unit address of the LU. This is in the range 1–255.
dlur_lu_detail.plu_name
Name of PLU if the LU has an active PLU-SLU session. This is a 17-byte string composed of two type-A EBCDIC character strings concatenated by an EBCDIC dot, and is right-padded with EBCDIC spaces. (Each name can have a maximum length of 8 bytes with no embedded spaces.) If the PLU-SLU session is not active, this field will be set to all zeros.
dlur_lu_detail.rscv_len
This value will always be zero.
If the verb does not execute because of a parameter error, the Program returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_INVALID_LU_NAME

AP_INVALID_FILTER_OPTION
AP_INVALID_LIST_OPTION

If the verb does not execute because the node has not yet been started, the Program returns the following parameter:
primary_rc
AP_NODE_NOT_STARTED
If the verb does not execute because of a system error, the Program returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR