cmpi
Public Attributes

_CMPIBrokerEncFT Struct Reference

#include <cmpi/cmpift.h>

List of all members.

Public Attributes

int ftVersion
CMPIInstance *(* newInstance )(const CMPIBroker *mb, const CMPIObjectPath *op, CMPIStatus *rc)
CMPIObjectPath *(* newObjectPath )(const CMPIBroker *mb, const char *ns, const char *cn, CMPIStatus *rc)
CMPIArgs *(* newArgs )(const CMPIBroker *mb, CMPIStatus *rc)
CMPIString *(* newString )(const CMPIBroker *mb, const char *data, CMPIStatus *rc)
CMPIArray *(* newArray )(const CMPIBroker *mb, CMPICount max, CMPIType type, CMPIStatus *rc)
CMPIDateTime *(* newDateTime )(const CMPIBroker *mb, CMPIStatus *rc)
CMPIDateTime *(* newDateTimeFromBinary )(const CMPIBroker *mb, CMPIUint64 binTime, CMPIBoolean interval, CMPIStatus *rc)
CMPIDateTime *(* newDateTimeFromChars )(const CMPIBroker *mb, const char *utcTime, CMPIStatus *rc)
CMPISelectExp *(* newSelectExp )(const CMPIBroker *mb, const char *query, const char *lang, CMPIArray **projection, CMPIStatus *st)
CMPIBoolean(* classPathIsA )(const CMPIBroker *mb, const CMPIObjectPath *op, const char *type, CMPIStatus *rc)
CMPIString *(* toString )(const CMPIBroker *mb, const void *object, CMPIStatus *rc)
CMPIBoolean(* isOfType )(const CMPIBroker *mb, const void *object, const char *type, CMPIStatus *rc)
CMPIString *(* getType )(const CMPIBroker *mb, const void *object, CMPIStatus *rc)
CMPIString *(* getMessage )(const CMPIBroker *mb, const char *msgId, const char *defMsg, CMPIStatus *rc, CMPICount count,...)
CMPIStatus(* logMessage )(const CMPIBroker *, int severity, const char *id, const char *text, const CMPIString *string)
CMPIStatus(* trace )(const CMPIBroker *, int level, const char *component, const char *text, const CMPIString *string)
CMPIError *(* newCMPIError )(const CMPIBroker *, const char *, const char *, const char *, const CMPIErrorSeverity, const CMPIErrorProbableCause, const CMPIrc, CMPIStatus *rc)
CMPIStatus(* openMessageFile )(const CMPIBroker *mb, const char *msgFile, CMPIMsgFileHandle *msgFileHandle)
CMPIStatus(* closeMessageFile )(const CMPIBroker *mb, const CMPIMsgFileHandle msgFileHandle)
CMPIString *(* getMessage2 )(const CMPIBroker *mb, const char *msgId, const CMPIMsgFileHandle msgFileHandle, const char *defMsg, CMPIStatus *rc, CMPICount count,...)

Detailed Description

This structure is a table of pointers to broker and factory services of encapsulated CMPIObjects. This table is made available by the Management Broker, aka CIMOM, whenever a provider is loaded and initialized.


Member Data Documentation

CMPIBoolean(* _CMPIBrokerEncFT::classPathIsA)(const CMPIBroker *mb, const CMPIObjectPath *op, const char *type, CMPIStatus *rc)

Function to determine whether a CIM class is of <type> or any of <type> subclasses.

Parameters:
mbPointer to the broker.
opThe class path (namespace and classname components).
typeThe type to tested for.
rcOutput: Service return status (suppressed when NULL).
Returns:
True if test successful.

Referenced by CmpiObjectPath::doClassPathIsA().

Closes a message file.

Parameters:
mbBroker this pointer
msgFileHandleThe handle representing the open message file.
Returns:
Service return status.

Function table version

CMPIString*(* _CMPIBrokerEncFT::getMessage)(const CMPIBroker *mb, const char *msgId, const char *defMsg, CMPIStatus *rc, CMPICount count,...)

Retrieves translated message.

Parameters:
mbPointer to the broker.
msgIdThe message identifier.
defMsgThe default message.
rcOutput: Service return status (suppressed when NULL).
countThe number of message substitution values.
Returns:
the trabslated message.
CMPIString*(* _CMPIBrokerEncFT::getMessage2)(const CMPIBroker *mb, const char *msgId, const CMPIMsgFileHandle msgFileHandle, const char *defMsg, CMPIStatus *rc, CMPICount count,...)

Retrieves translated message.

Parameters:
mbBroker this pointer
msgIdThe message identifier.
msgFileHandleThe handle representing the open message file.
defMsgThe default message.
rcOutput: Service return status (suppressed when NULL).
countThe number of message substitution values.
Returns:
the translated message.
CMPIString*(* _CMPIBrokerEncFT::getType)(const CMPIBroker *mb, const void *object, CMPIStatus *rc)

Retrieves the CMPI type of <object>. Intended for debugging purposes only.

Parameters:
mbPointer to the broker.
objectA valid CMPI object.
rcOutput: Service return status (suppressed when NULL).
Returns:
CMPI object type.
CMPIBoolean(* _CMPIBrokerEncFT::isOfType)(const CMPIBroker *mb, const void *object, const char *type, CMPIStatus *rc)

Verifies whether <object> is of CMPI type <type>. Intended for debugging purposes only.

Parameters:
mbPointer to the broker.
objectA valid CMPI object.
typeA string specifying a valid CMPI Object type ("CMPIInstance", "CMPIObjectPath", etc).
rcOutput: Service return status (suppressed when NULL).
Returns:
True if test successful.

Referenced by CmpiObject::doIsA().

CMPIStatus(* _CMPIBrokerEncFT::logMessage)(const CMPIBroker *, int severity, const char *id, const char *text, const CMPIString *string)

Logs a diagnostic message.

Parameters:
mbThe mb argument points to a CMPIBroker structure.
severityThe level argument describes the level of log message. Levels are defined in Section 4.9.
idThe component argument, if not NULL, is the component ID.
textThe text argument, if not NULL, is the message text to be logged.
stringThe string argument, if not NULL, is the message text to be logged. string will be ignored when text is not NULL.
Returns:
Service return status.

Args container factory service.

Parameters:
mbPointer to the broker.
rcOutput: Service return status (suppressed when NULL).
Returns:
The newly created Args container.

Referenced by CmpiArgs::makeArgs().

Array container factory service.

Parameters:
mbPointer to the broker.
maxMaximum number of elements
typeElement type
rcOutput: Service return status (suppressed when NULL).
Returns:
The newly created Array.

Referenced by CmpiArray::makeArray().

CMPIError*(* _CMPIBrokerEncFT::newCMPIError)(const CMPIBroker *, const char *, const char *, const char *, const CMPIErrorSeverity, const CMPIErrorProbableCause, const CMPIrc, CMPIStatus *rc)

Error factory service.

Parameters:
mbPointer to the broker.
msgIDA string which uniquely identifies, within the scope of the 'owner' argument, the format of the message.
msgA string which represenst the formatted message. sev The percieved severity of the error.
pcThe probably cause of this error
statusService return status.
Returns:
The newly created Error.

DateTime factory service. Initialized with the time of day.

Parameters:
mbPointer to the broker.
rcOutput: Service return status (suppressed when NULL).
Returns:
The newly created DateTime.

Referenced by CmpiDateTime::makeDateTime().

DateTime factory service. Initialized from <binTime>.

Parameters:
mbPointer to the broker.
binTimeDate/Time definition in binary format in microsecods starting since 00:00:00 GMT, Jan 1,1970.
intervalWenn true, defines Date/Time definition to be an interval value
rcOutput: Service return status (suppressed when NULL).
Returns:
The newly created DateTime.

Referenced by CmpiDateTime::makeDateTime().

DateTime factory service. Is initialized from <utcTime>.

Parameters:
mbPointer to the broker.
utcTimeDate/Time definition in UTC format
rcOutput: Service return status (suppressed when NULL).
Returns:
The newly created DateTime.

Referenced by CmpiDateTime::makeDateTime().

Instance factory service.

Parameters:
mbPointer to the broker.
opObjectPath containing namespace and classname.
rcOutput: Service return status (suppressed when NULL).
Returns:
The newly created Instance.

Referenced by CmpiInstance::makeInstance().

CMPIObjectPath*(* _CMPIBrokerEncFT::newObjectPath)(const CMPIBroker *mb, const char *ns, const char *cn, CMPIStatus *rc)

ObjectPath factory service.

Parameters:
mbPointer to the broker.
nsNamespace
cnClassname.
rcOutput: Service return status (suppressed when NULL).
Returns:
The newly created ObjectPath.

Referenced by CmpiObjectPath::makeObjectPath().

CMPISelectExp*(* _CMPIBrokerEncFT::newSelectExp)(const CMPIBroker *mb, const char *query, const char *lang, CMPIArray **projection, CMPIStatus *st)

SelectExp factory service.

Parameters:
mbPointer to the broker.
queryThe select expression.
langThe query language.
projectionOutput: Projection specification (suppressed when NULL).
rcOutput: Service return status (suppressed when NULL).
Returns:
The newly created SelectExp.
CMPIString*(* _CMPIBrokerEncFT::newString)(const CMPIBroker *mb, const char *data, CMPIStatus *rc)

String container factory service.

Parameters:
mbPointer to the broker.
dataString data
rcOutput: Service return status (suppressed when NULL).
Returns:
The newly created String.
CMPIStatus(* _CMPIBrokerEncFT::openMessageFile)(const CMPIBroker *mb, const char *msgFile, CMPIMsgFileHandle *msgFileHandle)

Opens a message file.

Parameters:
mbBroker this pointer
msgFileThe message file identifier.
msgFileHandleOutput: The handle representing the open message file.
Returns:
Service return status.
CMPIString*(* _CMPIBrokerEncFT::toString)(const CMPIBroker *mb, const void *object, CMPIStatus *rc)

Attempts to transforms an CMPI object to a broker specific string format. Intended for debugging purposes only.

Parameters:
mbPointer to the broker.
objectA valid CMPI object.
rcOutput: Service return status (suppressed when NULL).
Returns:
String from representation of <object>.

Referenced by CmpiObject::doToString().

CMPIStatus(* _CMPIBrokerEncFT::trace)(const CMPIBroker *, int level, const char *component, const char *text, const CMPIString *string)

Logs a trace entry. Intended for debugging purposes.

Parameters:
mbThe mb argument points to a CMPIBroker structure.
levelThe level argument describes the level of log message. Levels are defined in Section 4.9.
componentThe component argument, if not NULL, is the component ID.
textThe text argument, if not NULL, is the message text to be logged.
stringThe string argument, if not NULL, is the message text to be logged. string will be ignored when text is not NULL.
Returns:
Service return status.

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