_CMPIIndicationMIFT Struct Reference

#include <cmpi/cmpift.h>

List of all members.

Public Attributes
int	ftVersion
int	miVersion
const char *	miName
CMPIStatus(*	cleanup )(CMPIIndicationMI *mi, const CMPIContext *ctx, CMPIBoolean terminating)
CMPIStatus(*	authorizeFilter )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *op, const char *owner)
CMPIStatus(*	mustPoll )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath)
CMPIStatus(*	activateFilter )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath, CMPIBoolean firstActivation)
CMPIStatus(*	deActivateFilter )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath, CMPIBoolean lastActiviation)
CMPIStatus(*	enableIndications )(CMPIIndicationMI *mi, const CMPIContext *)
CMPIStatus(*	disableIndications )(CMPIIndicationMI *mi, const CMPIContext *)

---

Detailed Description

This structure is a table of pointers providing access to Indication provider functions. This table must be returend during initialization by the provider.

---

Member Data Documentation

CMPIStatus(* _CMPIIndicationMIFT::activateFilter)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath, CMPIBoolean firstActivation)

Ask the provider to begin monitoring a resource. The function shall begin monitoring the resource according to the filter express only. Parameters: mi  The mi argument is a pointer to a CMPIIndicationMI structure. ctx  The ctx argument is a pointer to a CMPIContext structure containing the Invocation Context. filter  The filter argument contains the filter specification for this subscription to become active. className  The class name extracted from the filter FROM clause. classPath  The name of the class for which monitoring is required. Only the namespace part is set if eventType is a process indication. firstActivation  Set to true if this is the first filter for className. Returns: The function shall return a CMPIStatus structure containing the service return status. The following CMPIrc codes shall be recognized: CMPI_RC_OK Operation successful. CMPI_RC_ERR_FAILED Unspecific error occurred. CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI. CMPI_RC_ERR_ACCESS_DENIED Not authorized. CMPI_RC_ERR_INVALID_QUERY Invalid query or too complex.

CMPIStatus(* _CMPIIndicationMIFT::authorizeFilter)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *op, const char *owner)

Ask the provider to verify whether this filter is allowed. Parameters: mi  The mi argument is a pointer to a CMPIIndicationMI structure. ctx  The ctx argument is a pointer to a CMPIContext structure containing the Invocation Context. filter  Contains the filter that must be authorized. className  Contains the class name extracted from the filter FROM clause. op  The name of the class for which monitoring is required. Only the namespace part is set if className is a process indication. owner  The owner argument is the destination owner. Returns: This function shall structure containing the service return status. The following CMPIrc codes shall be recognized: CMPI_RC_OK Operation successful. CMPI_RC_ERR_FAILED Unspecific error occurred. CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this CMPI_RC_ERR_ACCESS_DENIED Not authorized. CMPI_RC_ERR_INVALID_QUERY Invalid query or too complex.

CMPIStatus(* _CMPIIndicationMIFT::cleanup)(CMPIIndicationMI *mi, const CMPIContext *ctx, CMPIBoolean terminating)

Cleanup is called prior to unloading of the provider. This function shall perform any necessary cleanup operation prior to the unloading of the library of which this MI group is part. Parameters: mi  The mi argument is a pointer to a CMPIIndicationMI structure. ctx  The ctx argument is a pointer to a CMPIContext structure containing the Invocation Context. terminating  When true, the terminating argument indicates that the MB is in the process of terminating and that cleanup must be done. When set to false, the MI may respond with CMPI_RC_DO_NOT_UNLOAD, or CMPI_RC_NEVER_UNLOAD, indicating that unload will interfere with current MI processing. Returns: Function return status. The following CMPIrc codes shall be recognized: CMPI_RC_OK Operation successful. CMPI_RC_ERR_FAILED Unspecific error occurred. CMPI_RC_DO_NOT_UNLOAD Operation successful do not unload now. CMPI_RC_NEVER_UNLOAD Operation successful never unload

CMPIStatus(* _CMPIIndicationMIFT::deActivateFilter)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath, CMPIBoolean lastActiviation)

Inform the MI that monitoring using this filter should stop. The function invocation mandates the MI to stop monitoring the resource using this filter. Parameters: mi  The mi argument is a pointer to a CMPIIndicationMI structure. ctx  The ctx argument is a pointer to a CMPIContext structure containing the Invocation Context. filter  The filter argument contains the filter specification for this subscription to become active. className  The class name extracted from the filter FROM clause. classPath  The name of the class for which monitoring is required. Only the namespace part is set if className is a process indication. lastActiviation  Set to true if this is the last filter for className. Returns: The function shall return a CMPIStatus structure containing the service return status. The following CMPIrc codes shall be recognized: CMPI_RC_OK Operation successful. CMPI_RC_ERR_FAILED Unspecific error occurred. CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI. CMPI_RC_ERR_ACCESS_DENIED Not authorized. CMPI_RC_ERR_INVALID_QUERY Invalid query or too complex.

CMPIStatus(* _CMPIIndicationMIFT::disableIndications)(CMPIIndicationMI *mi, const CMPIContext *)

Tell the MI to stop generating indications. MB will not accept any indications until enabled again. The function is normally called when the MB is shutting down indication services either temporarily or permanently. Parameters: mi  The mi argument is a pointer to a CMPIIndicationMI structure. ctx  The ctx argument is a pointer to a CMPIContext structure containing the Invocation Context. Returns: The function shall return a CMPIStatus structure containing the service return status. The following CMPIrc codes shall be recognized: CMPI_RC_OK Operation successful. CMPI_RC_ERR_FAILED Unspecific error occurred. CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.

CMPIStatus(* _CMPIIndicationMIFT::enableIndications)(CMPIIndicationMI *mi, const CMPIContext *)

Tell the MI that indications can now be generated. The MB is now prepared to process indications. The function is normally called by the MB after having done its intialization and processing of persistent subscription requests. Parameters: mi  The mi argument is a pointer to a CMPIIndicationMI structure. ctx  The ctx argument is a pointer to a CMPIContext structure containing the Invocation Context. Returns: The function shall return a CMPIStatus structure containing the service return status. The following CMPIrc codes shall be recognized: CMPI_RC_OK Operation successful. CMPI_RC_ERR_FAILED Unspecific error occurred. CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.

int _CMPIIndicationMIFT::ftVersion

Function table version

const char* _CMPIIndicationMIFT::miName

Provider name

int _CMPIIndicationMIFT::miVersion

Provider version

CMPIStatus(* _CMPIIndicationMIFT::mustPoll)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath)

Ask the MI whether polling mode should be used. This function enables very simple MIs to support indications without providing a complete indication support implementation. When true is returned, the MB will enumerate the instances of this MI at regular intervals and apply indication filters. Parameters: mi  The mi argument is a pointer to a CMPIIndicationMI structure. ctx  The ctx argument is a pointer to a CMPIContext structure containing the Invocation Context. className  The class name extracted from the filter FROM clause. filter  The name of the class for which monitoring is required. Only the namespace part is set if eventType is a process indication. classPath  The name of the class for which polling would be used. Only the namespace part is set if className is a process indication. Returns: This function shall return a CMPIStatus structure containing the service return status. The following CMPIrc codes shall be recognized: CMPI_RC_OK Operation successful. CMPI_RC_ERR_FAILED Unspecific error occurred. CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI. CMPI_RC_ERR_ACCESS_DENIED Not authorized. CMPI_RC_ERR_INVALID_QUERY Invalid query or too complex.

---

The documentation for this struct was generated from the following file:

• cmpi/cmpift.h

---