3.1.4.2.56 ApiCreateNotify (Opnum 55)

  • Article

(Protocol Version 3) The ApiCreateNotify method establishes context on the server about the interaction of a client with a version 1 cluster notification port by using the current RPC connection.

Upon receipt of this method, the server MUST create and maintain a queuing mechanism for posting event indications to the port, as described in section 3.1.1.8. This mechanism is maintained using implementation-specific methods and protocols between servers.

The server MUST NOT queue any event indications to the port until the first event filter has been registered, as specified in ApiAddNotifyCluster (section 3.1.4.2.58), ApiAddNotifyNode (section 3.1.4.2.59), ApiAddNotifyGroup (section 3.1.4.2.60), ApiAddNotifyResource (section 3.1.4.2.61), ApiAddNotifyKey (section 3.1.4.2.62), ApiAddNotifyNetwork (section 3.1.4.2.90), and ApiAddNotifyNetInterface (section 3.1.4.2.99).

The server SHOULD accept an ApiCreateNotify 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.

The server SHOULD accept an ApiCreateNotify request if the client's access level is at least "Read" (section 3.1.4).

 HNOTIFY_RPC ApiCreateNotify(
   [out] error_status_t *Status,
   [out] error_status_t *rpc_status
 );

Status: Indicates the status of this operation. The server MUST set Status to the following error codes for the specified conditions.

Value

Meaning

ERROR_SUCCESS

0x00000000

Success.

For any other condition, the server MUST set Status to a value that is not one of the values listed in the preceding table. The client MUST treat all values that are not listed in the preceding table the same, except as specified in section 3.2.4.6.

rpc_status: A 32-bit integer used to indicate success or failure. The RPC runtime MUST indicate, by writing to this parameter, whether the runtime succeeded in executing this method on the server. The encoding of the value passed in this parameter MUST conform to encoding for comm_status and fault_status, as specified in Appendix E of [C706].

Return Values: The method MUST return a valid HNOTIFY_RPC (section 2.2.1.6) context handle, as specified in section 2.2.1.6, to indicate success; otherwise, it MUST return NULL.