cmpi
Public Attributes | List of all members
_CMPIIndicationMIFT Struct Reference

#include <cmpi/cmpift.h>

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

◆ activateFilter

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
miThe mi argument is a pointer to a CMPIIndicationMI structure.
ctxThe ctx argument is a pointer to a CMPIContext structure containing the Invocation Context.
filterThe filter argument contains the filter specification for this subscription to become active.
classNameThe class name extracted from the filter FROM clause.
classPathThe name of the class for which monitoring is required. Only the namespace part is set if eventType is a process indication.
firstActivationSet 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.

◆ authorizeFilter

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
miThe mi argument is a pointer to a CMPIIndicationMI structure.
ctxThe ctx argument is a pointer to a CMPIContext structure containing the Invocation Context.
filterContains the filter that must be authorized.
classNameContains the class name extracted from the filter FROM clause.
opThe name of the class for which monitoring is required. Only the namespace part is set if className is a process indication.
ownerThe 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.

◆ cleanup

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
miThe mi argument is a pointer to a CMPIIndicationMI structure.
ctxThe ctx argument is a pointer to a CMPIContext structure containing the Invocation Context.
terminatingWhen 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

◆ deActivateFilter

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
miThe mi argument is a pointer to a CMPIIndicationMI structure.
ctxThe ctx argument is a pointer to a CMPIContext structure containing the Invocation Context.
filterThe filter argument contains the filter specification for this subscription to become active.
classNameThe class name extracted from the filter FROM clause.
classPathThe name of the class for which monitoring is required. Only the namespace part is set if className is a process indication.
lastActiviationSet 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.

◆ disableIndications

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
miThe mi argument is a pointer to a CMPIIndicationMI structure.
ctxThe 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.

◆ enableIndications

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
miThe mi argument is a pointer to a CMPIIndicationMI structure.
ctxThe 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.

◆ ftVersion

int _CMPIIndicationMIFT::ftVersion

Function table version

◆ miName

const char* _CMPIIndicationMIFT::miName

Provider name

◆ miVersion

int _CMPIIndicationMIFT::miVersion

Provider version

◆ mustPoll

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
miThe mi argument is a pointer to a CMPIIndicationMI structure.
ctxThe ctx argument is a pointer to a CMPIContext structure containing the Invocation Context.
classNameThe class name extracted from the filter FROM clause.
filterThe name of the class for which monitoring is required. Only the namespace part is set if eventType is a process indication.
classPathThe 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: