Previous Page Contents Page Next Page

3.190 UNREGISTER_INDICATION_SINK

UNREGISTER_INDICATION_SINK unregisters the NOF application so that it no longer receives indications of a particular type (previously specified using REGISTER_INDICATION_SINK).

If the application has registered more than once to accept multiple indication types, it must unregister separately for each indication that it no longer wants to receive.

This verb must always be issued using the asynchronous NOF API entry point, including the callback routine that was supplied on the REGISTER_INDICATION_SINK verb (for more information about the asynchronous NOF API entry point, see Asynchronous Entry Point: nof_async).

This verb may be issued to the domain configuration file, to a running node or to a server where the node is not running, or to the sna.net file, depending on the type of indication for which the application is unregistering.

3.190.1 VCB Structure

typedef struct unregister_indication_sink
{
   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             */
   AP_UINT32        proc_id;            /* reserved                          */
   AP_UINT16        queue_id;           /* reserved                          */
   AP_UINT16        indication_opcode;  /* opcode of indication to be unsunk */
} UNREGISTER_INDICATION_SINK;

3.190.2 Supplied Parameters

The application supplies the following parameters:

opcode

AP_UNREGISTER_INDICATION_SINK

indication_opcode

The opcode parameter of the indication that is no longer required.

3.190.3 Returned Parameters: Successful Execution

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

primary_rc

AP_OK

3.190.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_OP_CODE

The indication_opcode parameter did not match the opcode of any of the SNAP-IX NOF indications, or the application has not previously registered to receive the specified indication on this target handle.

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

3.190.5 Returned Parameters: Function Not Supported

If the verb does not execute successfully because the local node does not support the function associated with the specified indication, SNAP-IX returns the following parameters:

primary_rc

AP_FUNCTION_NOT_SUPPORTED

The local node does not support the specified indication. For details of the support required for each indication, see the description of each indication in NOF Indications.

3.190.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