REGISTER_INDICATION_SINK

REGISTER_INDICATION_SINK registers a process and queue to which indications should be sent.

The orig_verb_data in the verb_signal header of REGISTER_INDICATION_SINK is returned in the verb_signal header of any indications received.

VCB Structure

typedef struct register_indication_sink
{
   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 PROC_ID
                   proc_id;               /* process identifier of sink    */
   unsigned QUEUE_ID
                   queue_id;              /* queue identifier where        */
                                          /* indications will be sent      */
   unsigned short  indication_opcode;     /* opcode of indication to       */
                                          /* be sunk                       */
} REGISTER_INDICATION_SINK;

Parameters

opcode
AP_REGISTER_INDICATION_SINK
format
Identifies the format of the VCB. This field is set to zero to specify the version of the VCB listed above.
proc_id
Process ID of receiving process.
queue_id
Queue ID where receiving process indications should be sent.
indication_opcode
Opcode of the indication that is to be returned whenever generated, once the indication sink has been registered.

Returned Parameters

If the verb executes successfully, the Program returns the following parameter:
primary_rc
AP_OK
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_OP_CODE

AP_DYNAMIC_LOAD_ALREADY_REGD

If the verb does not execute because of a state error, the Program returns the following parameters:
primary_rc
AP_STATE_CHECK
secondary_rc
AP_INVALID_LU_NAME
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 a STOP_NODE verb has been issued, the Program returns the following parameter:
primary_rc
AP_NODE_STOPPING
If the verb does not execute because of a system error, the Program returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR