CMPI 2.1.0 API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Variables
Indications Services (Subclause 9.3)

Variables

CMPIStatus(* CMPIBrokerFT::deliverIndication )(const CMPIBroker *mb, const CMPIContext *ctx, const char *ns, const CMPIInstance *ind)
 Request delivery of an indication. More...
 

Detailed Description

Variable Documentation

CMPIStatus(* CMPIBrokerFT::deliverIndication)(const CMPIBroker *mb, const CMPIContext *ctx, const char *ns, const CMPIInstance *ind)

Request delivery of an indication.

CMPIBrokerFT.deliverIndication() requests the delivery of an indication.

The MB will locate pertinent subscribers and send the indication to each of them.

This function may be called by an MI regardless of whether or not there are any active indication filters or indication filter collections that cover the indication to be delivered. If there are no such filters or filter collections, this will not cause the function to fail. For the concept of coverage of indications by an indication filter or indication filter collection, see DSP1054.

This function may be called by an MI regardless of whether or not the MB is ready for processing the delivery of indications, as communicated to the MI via CMPIIndicationMIFT.enableIndications() and CMPIIndicationMIFT.disableIndications(). If the MB is not ready for processing the delivery of indications, this will not cause the function to fail. The MB implementation may choose to drop the indication in this case, or to queue the indication for later delivery.

This function may be called by any MI function, and by any threads created by MIs that are registered with the MB (see Thread Registration Services).

Parameters
mbPoints to a CMPIBroker structure.
ctxPoints to the CMPIContext object that was used to invoke the MI function that calls this MB function, or that was used to register the thread that calls this MB function.
nsName of the origin namespace of the indication (see DSP1054 for a definition).
indPoints to a CMPIInstance object containing the indication instance. An instance path specified in that CMPIInstance object is meaningless for indication instances and will be ignored by the MB.
Returns
CMPIStatus structure containing the function return status.
Errors
The function return status will indicate one of the following CMPIrc codes:
  • CMPI_RC_OK - Function successful.
    Note: If the MB is not ready for processing the delivery of indications, it may drop the indication and still return success.
  • CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB.
  • CMPI_RC_ERR_INVALID_HANDLE - The mb, ctx, or ind handle is invalid.
  • CMPI_RC_ERR_INVALID_PARAMETER - The namespace specified by ns is invalid, or the indication instance specified by ind is invalid.
Convenience Function
CBDeliverIndication()
Capabilities:
Part of the Indications capability.
Change:
In CMPI 2.1, added the return code CMPI_RC_ERR_INVALID_PARAMETER.