_CMPIBrokerFT Struct Reference

#include <cmpi/cmpift.h>

List of all members.

Public Attributes
unsigned int	brokerCapabilities
unsigned int	brokerVersion
const char *	brokerName
CMPIContext *(*	prepareAttachThread )(const CMPIBroker *mb, const CMPIContext *ctx)
CMPIStatus(*	attachThread )(const CMPIBroker *, const CMPIContext *)
CMPIStatus(*	detachThread )(const CMPIBroker *mb, const CMPIContext *ctx)
CMPIStatus(*	deliverIndication )(const CMPIBroker *mb, const CMPIContext *ctx, const char *ns, const CMPIInstance *ind)
CMPIEnumeration *(*	enumerateInstanceNames )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, CMPIStatus *rc)
CMPIInstance *(*	getInstance )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char **properties, CMPIStatus *rc)
CMPIObjectPath *(*	createInstance )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const CMPIInstance *inst, CMPIStatus *rc)
CMPIStatus(*	modifyInstance )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const CMPIInstance *inst, const char **properties)
CMPIStatus(*	deleteInstance )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op)
CMPIEnumeration *(*	execQuery )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *query, const char *lang, CMPIStatus *rc)
CMPIEnumeration *(*	enumerateInstances )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char **properties, CMPIStatus *rc)
CMPIEnumeration *(*	associators )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *assocClass, const char *resultClass, const char *role, const char *resultRole, const char **properties, CMPIStatus *rc)
CMPIEnumeration *(*	associatorNames )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *assocClass, const char *resultClass, const char *role, const char *resultRole, CMPIStatus *rc)
CMPIEnumeration *(*	references )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *resultClass, const char *role, const char **properties, CMPIStatus *rc)
CMPIEnumeration *(*	referenceNames )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *resultClass, const char *role, CMPIStatus *rc)
CMPIData(*	invokeMethod )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *method, const CMPIArgs *in, CMPIArgs *out, CMPIStatus *rc)
CMPIStatus(*	setProperty )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *name, const CMPIValue *value, CMPIType type)
CMPIData(*	getProperty )(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *name, CMPIStatus *rc)

---

Detailed Description

This structure is a table of pointers to broker CIMOM services (up-calls). This table is made available by the Management Broker, whenever a provider is loaded and initialized.

---

Member Data Documentation

CMPIEnumeration*(* _CMPIBrokerFT::associatorNames)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *assocClass, const char *resultClass, const char *role, const char *resultRole, CMPIStatus *rc)

Enumerate ObjectPaths associated with the Instance defined by <op>. Parameters: mb  Pointer to the broker. ctx  Context object op  Source ObjectPath containing namespace, classname and key components. assocClass  If not NULL, MUST be a valid Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses. resultClass  If not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses). role  If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter). resultRole  If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter). rc  Output: Service return status (suppressed when NULL). Returns: Enumeration of ObjectPaths.

CMPIEnumeration*(* _CMPIBrokerFT::associators)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *assocClass, const char *resultClass, const char *role, const char *resultRole, const char **properties, CMPIStatus *rc)

Enumerate instances associated with the Instance defined by the <op>. Parameters: mb  Pointer to the broker. ctx  Context object op  Source ObjectPath containing namespace, classname and key components. assocClass  If not NULL, MUST be a valid Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses. resultClass  If not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses). role  If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter). resultRole  If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter). properties  If not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list rc  Output: Service return status (suppressed when NULL). Returns: Enumeration of Instances.

CMPIStatus(* _CMPIBrokerFT::attachThread)(const CMPIBroker *, const CMPIContext *)

This function informs the CMPI run time system that the current thread with Context will begin using CMPI services. Parameters: mb  Pointer to the broker. ctx  Context object Returns: Service return status.

unsigned int _CMPIBrokerFT::brokerCapabilities

32 bits describing CMPI features supported by this CIMOM. See CMPI_MB_Class_x and CMPI_MB_Supports_xxx flags.

const char* _CMPIBrokerFT::brokerName

CIMOM name

unsigned int _CMPIBrokerFT::brokerVersion

CIMOM version as defined by CIMOM

CMPIObjectPath*(* _CMPIBrokerFT::createInstance)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const CMPIInstance *inst, CMPIStatus *rc)

Create Instance from <inst> using <op> as reference. Parameters: mb  Pointer to the broker. ctx  Context object op  ObjectPath containing namespace, classname and key components. inst  Complete instance. rc  Output: Service return status (suppressed when NULL). Returns: The assigned instance reference.

CMPIStatus(* _CMPIBrokerFT::deleteInstance)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op)

Delete an existing Instance using <op> as reference. Parameters: mb  Pointer to the broker. ctx  Context object op  ObjectPath containing namespace, classname and key components. Returns: Service return status.

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

This function requests delivery of an Indication. The CIMOM will locate pertinent subscribers and notify them about the event. Parameters: mb  Pointer to the broker. ctx  Context object ns  Namespace ind  Indication Instance Returns: Service return status.

CMPIStatus(* _CMPIBrokerFT::detachThread)(const CMPIBroker *mb, const CMPIContext *ctx)

This function informs the CMPI run time system that the current thread will not be using CMPI services anymore. The Context object will be freed during this operation. Parameters: mb  Pointer to the broker. ctx  Context object Returns: Service return status.

CMPIEnumeration*(* _CMPIBrokerFT::enumerateInstanceNames)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, CMPIStatus *rc)

Enumerate Instance Names of the class (and subclasses) defined by <op>. Parameters: mb  Pointer to the broker. ctx  Context object op  ObjectPath containing namespace and classname components. rc  Output: Service return status (suppressed when NULL). Returns: Enumeration of ObjectPathes.

CMPIEnumeration*(* _CMPIBrokerFT::enumerateInstances)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char **properties, CMPIStatus *rc)

Enumerate Instances of the class (and subclasses) defined by <op>. Instance structure and inheritance scope can be controled using the CMPIInvocationFlags entry in <ctx>. Parameters: mb  Pointer to the broker. ctx  Context object op  ObjectPath containing namespace and classname components. properties  If not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list rc  Output: Service return status (suppressed when NULL). Returns: Enumeration of Instances.

CMPIEnumeration*(* _CMPIBrokerFT::execQuery)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *query, const char *lang, CMPIStatus *rc)

Query the enumeration of instances of the class (and subclasses) defined by <op> using <query> expression. Parameters: mb  Pointer to the broker. ctx  Context object op  ObjectPath containing namespace and classname components. query  Query expression lang  Query Language rc  Output: Service return status (suppressed when NULL). Returns: Resulting eumeration of Instances.

CMPIInstance*(* _CMPIBrokerFT::getInstance)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char **properties, CMPIStatus *rc)

Get Instance using <op> as reference. Instance structure can be controled using the CMPIInvocationFlags entry in <ctx>. Parameters: mb  Pointer to the broker. ctx  Context object op  ObjectPath containing namespace, classname and key components. properties  If not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list rc  Output: Service return status (suppressed when NULL). Returns: The Instance.

CMPIData(* _CMPIBrokerFT::getProperty)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *name, CMPIStatus *rc)

Get the named property value of an Instance defined by the <op> parameter. Parameters: mb  Pointer to the broker. ctx  Context object op  ObjectPath containing namespace, classname and key components. name  Property name rc  Output: Service return status (suppressed when NULL). Returns: Property value.

CMPIData(* _CMPIBrokerFT::invokeMethod)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *method, const CMPIArgs *in, CMPIArgs *out, CMPIStatus *rc)

Invoke a named, extrinsic method of an Instance defined by the <op> parameter. Parameters: mb  Pointer to the broker. ctx  Context object op  ObjectPath containing namespace, classname and key components. method  Method name in  Input parameters. out  Output parameters. rc  Output: Service return status (suppressed when NULL). Returns: Method return value.

CMPIStatus(* _CMPIBrokerFT::modifyInstance)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const CMPIInstance *inst, const char **properties)

Replace an existing Instance from <inst> using <op> as reference. Parameters: mb  Pointer to the broker. ctx  Context object op  ObjectPath containing namespace, classname and key components. inst  Complete instance. Returns: Service return status.

CMPIContext*(* _CMPIBrokerFT::prepareAttachThread)(const CMPIBroker *mb, const CMPIContext *ctx)

This function prepares the CMPI run time system to accept a thread that will be using CMPI services. The returned CMPIContext object must be used by the subsequent attachThread() and detachThread() invocations. Parameters: mb  Pointer to the broker. ctx  Old Context object Returns: New Context object to be used by thread to be attached.

CMPIEnumeration*(* _CMPIBrokerFT::referenceNames)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *resultClass, const char *role, CMPIStatus *rc)

Enumerates the association ObjectPaths that refer to the instance defined by <op>. Parameters: mb  Pointer to the broker. ctx  Context object op  Source ObjectPath containing namespace, classname and key components. resultClass  If not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses). role  If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter). rc  Output: Service return status (suppressed when NULL). Returns: Enumeration of ObjectPaths.

CMPIEnumeration*(* _CMPIBrokerFT::references)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *resultClass, const char *role, const char **properties, CMPIStatus *rc)

Enumerates the association instances that refer to the instance defined by <op>. Parameters: mb  Pointer to the broker. ctx  Context object op  Source ObjectPath containing namespace, classname and key components. resultClass  If not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses). role  If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter). properties  If not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list rc  Output: Service return status (suppressed when NULL). Returns: Enumeration of ObjectPaths.

CMPIStatus(* _CMPIBrokerFT::setProperty)(const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *op, const char *name, const CMPIValue *value, CMPIType type)

Set the named property value of an Instance defined by the <op> parameter. Parameters: mb  Pointer to the broker. ctx  Context object op  ObjectPath containing namespace, classname and key components. name  Property name value  Value. type  Value type. Returns: Service return status.

---

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

• cmpi/cmpift.h

---