Previous Page Contents Page Next Page

3.181 START_DLC

START_DLC requests the activation of a DLC.

This verb must be issued to a running node.

3.181.1 VCB Structure

typedef struct start_dlc
{
   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    dlc_name[8];                 /* name of DLC              */
} START_DLC;

3.181.2 Supplied Parameters

The application supplies the following parameters:

opcode

AP_START_DLC

dlc_name

Name of the DLC to be started. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes, which must match the name of a defined DLC.

3.181.3 Returned Parameters: Successful Execution

If the verb executes successfully, SNAP-IX returns the following parameter:

primary_rc

AP_OK

This return code indicates only that the verb was issued successfully; the verb does not wait for the DLC to initialize, and so does not return error return codes if the initialization of the DLC fails. DLC initialization failures are reported using messages written to the error log file.

3.181.4 Returned Parameters: Parameter Check

If the verb does not execute because of a parameter error, SNAP-IX returns the following parameters:

primary_rc

AP_PARAMETER_CHECK

secondary_rc

AP_INVALID_DLC

The dlc_name parameter was not the name of a defined DLC.

Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.

3.181.5 Returned Parameters: State Check

If the verb does not execute because of a state error, SNAP-IX returns the following parameters.

primary_rc

AP_STATE_CHECK

secondary_rc

AP_DLC_DEACTIVATING

The specified DLC has already been started, and is in the process of being deactivated.

Common Return Codes lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.

3.181.6 Returned Parameters: Other Conditions

Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs.

Previous Page Contents Page Top of Page Next page