18.104.22.168.59 ApiAddNotifyNode (Opnum 58)
(Protocol Version 2) The ApiAddNotifyNode method instructs the server to begin queuing event indications. Event indications correspond to internal clusternode state and configuration changes that map to a value in the designated filter of the designated version 1 notification port. Indications are queued for the node represented by the designated context handle.
The server SHOULD accept an ApiAddNotifyNode request if its protocol server state is read-only and MUST accept the request for processing if it is in the read/write state, as specified in section 3.1.1.
error_status_t ApiAddNotifyNode( [in] HNOTIFY_RPC hNotify, [in] HNODE_RPC hNode, [in] DWORD dwFilter, [in] DWORD dwNotifyKey, [out] DWORD* dwStateSequence );
dwFilter: A 32-bit integer bitmask containing one or more node-specific values in a CLUSTER_CHANGE (section 22.214.171.124) enumeration. The value of this parameter MUST be set to the bitwise OR operator of one or more of the following values: CLUSTER_CHANGE_NODE_ADDED, CLUSTER_CHANGE_NODE_DELETED, CLUSTER_CHANGE_NODE_STATE, or CLUSTER_CHANGE_NODE_PROPERTY.
dwNotifyKey: A 32-bit integer context value chosen by the client. This value MUST be returned to the client via a subsequent completion of the ApiGetNotify (section 126.96.36.199.66) method, if the name of the object pertaining to the event matches the name of the object designated by hNode (the second parameter).
dwStateSequence: The address of a 32-bit integer that the server MUST write upon successful completion of this method. The client MUST retain the most current value of this parameter and provide it back to the server via the StateSequence parameter of the ApiReAddNotifyNode (section 188.8.131.52.63) method.
Return Values: The method MUST return the following error codes for the specified conditions.
Return value/code Description
The data that is pointed to by the hNotify parameter or the hNode parameter does not respectively represent a valid HNOTIFY_RPC (section 184.108.40.206) or HNODE_RPC (section 220.127.116.11) context handle.
For any other condition, this method MUST return a value that is not one of the values listed in the preceding table. The client MUST behave in one consistent, identical manner for all values that are not listed in the preceding table. The client SHOULD treat errors specified in 18.104.22.168 as recoverable errors, and initiate the reconnect procedure as specified in section 22.214.171.124.