QUERY_DSPU_TEMPLATE


The Communications Server icon lets you know that there is a change in the way things operate.
This verb applies only to Communications Server.
QUERY_DSPU_TEMPLATE returns information about defined downstream PU templates used for PU concentration over implicit links. This information is returned as a list. To obtain information about a specific downstream PU template or to obtain the list information in several chunks, the template_name field should be set. Otherwise (if the list_options field is set to AP_FIRST_IN_LIST), this field is ignored. See Querying the Node for background on how the list formats are used.

VCB Structure

typedef struct query_dspu_template
{
        unsigned short  opcode;            /* verb operation code           */
        unsigned char   attributes;        /* Verb attributes               */
        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   template_name[8];  /* name of DSPU template         */
} QUERY_DSPU_TEMPLATE;
typedef struct dspu_template_data
{
        unsigned short  overlay_size;      /* size of this entry            */
        unsigned char   template_name[8];  /* name of DSPU template         */
        unsigned char   description;       /* resource description          */
        unsigned char   reserv1[12];       /* reserved                      */
        unsigned short  max_instance;      /* max active template instances */
        unsigned short  active instance;   /* current active instances      */
        unsigned short  num_of_dslu_templates;
                                           /* number of DSLU templates      */
} DSPU_TEMPLATE_DATA;
Each dspu_template_data is followed by num_of_dslu_templates downstream LU templates. Each downstream LU template has the following format.
typedef struct dslu_template_data
{
        unsigned short  overlay_size;      /* size of this entry            */
        unsigned char   reserv1[2];        /* reserved                      */
        DSLU_TEMPLATE   dslu_template;     /* downstream LU template        */
} DSLU_TEMPLATE_DATA;
typedef struct dslu_template
{
        unsigned char   min_nau;           /* min NAU address in range      */
        unsigned char   max_nau;           /* max NAU address in range      */
        unsigned char   allow_timeout;     /* Allow timeout of host LU?     */
        unsigned char   delayed_logon;     /* Allow delayed logon to host LU */
        unsigned char   reserv1[10];       /* reserved                      */
        unsigned char   host_lu[8];        /* host LU or pool name          */
} DSLU_TEMPLATE;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_QUERY_DSPU_TEMPLATE
attributes
The attributes of the verb. This field is a bit field. The first bit contains the visibility of the resource to be defined and corresponds to one of the following:

AP_EXTERNALLY_VISIBLE
AP_INTERNALLY_VISIBLE

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:
The template_name specified (see the following parameter, template_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.
template_name
Name of the DSPU template. This is an 8–byte string in a locally-displayable character set. This field is ignored if list_options is set to AP_FIRST_IN_LIST.

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.
dspu_template_data.overlay_size
The number of bytes in this entry (including any downstream LU templates, and hence the offset to the next entry returned, if any).
dspu_template_data.template_name
Name of the DSPU template. This is an 8–byte string in a locally-displayable character set.
dspu_template_data.description
Resource description (as specified on QUERY_DSPU_TEMPLATE).
dspu_template_data.max_instance
This is the maximum number of instances of the template which can be active concurrently.
dspu_template_data.active_instance
This is the number of instances of the template which are currently active.
dspu_template_data.num_of_dslu_templates
Number of downstream LU templates for this downstream PU template. Following this field are num_of_dslu_templates_application_id entries, one for each application registered for the focal point category.
dslu_template_data.overlay_size
The number of bytes in this entry (and hence the offset to the next entry returned, if any).
dslu_template_data.dslu_template.min_nau
Minimum NAU address in the range.
dslu_template_data.dslu_template.max_nau
Maximum NAU address in the range.
dslu_template_data.dslu_template.allow_timeout
Specifies whether the Program is allowed to time out host LUs used by this downstream LU if the session is left inactive for the timeout period specified on the host LU definition (AP_YES or AP_NO).
dslu_template_data.dslu_template.delayed_logon
Specifies whether the Program should delay connecting the downstream LU to the host LU until the first data is received from the downstream LU. Instead, a simulated logon screen is sent to the downstream LU (AP_YES or AP_NO).
dslu_template_data.dslu_template.host_lu
Name of the host LU or host LU pool that all the downstream LUs within the range will be mapped onto. This is an 8-byte alphanumeric type A-EBCDIC string (starting with a letter), padded to the right with EBCDIC Spaces.
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_TEMPLATE_NAME

AP_INVALID_LIST_OPTION

If the verb does not execute because one or more of the relevant START_NODE parameters were not set, the Program returns the following parameter:
primary_rc
AP_FUNCTION_NOT_SUPPORTED
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 parameters:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR