_CMPIBrokerEncFT Struct Reference

#include <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 *, CMPISeverity severity, const char *id, const char *text, const CMPIString *string)
CMPIStatus(* trace )(const CMPIBroker *, CMPILevel 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:
mb Pointer to the broker.
op The class path (namespace and classname components).
type The type to tested for.
rc Output: Service return status (suppressed when NULL).
Returns:
True if test successful.
CMPIStatus(* _CMPIBrokerEncFT::closeMessageFile)(const CMPIBroker *mb, const CMPIMsgFileHandle msgFileHandle)

Closes a message file.

Parameters:
mb Broker this pointer
msgFileHandle The 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:
mb Pointer to the broker.
msgId The message identifier.
defMsg The default message.
rc Output: Service return status (suppressed when NULL).
count The 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:
mb Broker this pointer
msgId The message identifier.
msgFileHandle The handle representing the open message file.
defMsg The default message.
rc Output: Service return status (suppressed when NULL).
count The 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:
mb Pointer to the broker.
object A valid CMPI object.
rc Output: 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:
mb Pointer to the broker.
object A valid CMPI object.
type A string specifying a valid CMPI Object type ("CMPIInstance", "CMPIObjectPath", etc).
rc Output: Service return status (suppressed when NULL).
Returns:
True if test successful.
CMPIStatus(* _CMPIBrokerEncFT::logMessage)(const CMPIBroker *, CMPISeverity severity, const char *id, const char *text, const CMPIString *string)

Logs a diagnostic message.

Parameters:
mb The mb argument points to a CMPIBroker structure.
severity The level argument describes the level of log message. Levels are defined in Section 4.9.
id The component argument, if not NULL, is the component ID.
text The text argument, if not NULL, is the message text to be logged.
string The 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:
mb Pointer to the broker.
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created Args container.
CMPIArray*(* _CMPIBrokerEncFT::newArray)(const CMPIBroker *mb, CMPICount max, CMPIType type, CMPIStatus *rc)

Array container factory service.

Parameters:
mb Pointer to the broker.
max Maximum number of elements
type Element type
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created Array.
CMPIError*(* _CMPIBrokerEncFT::newCMPIError)(const CMPIBroker *, const char *, const char *, const char *, const CMPIErrorSeverity, const CMPIErrorProbableCause, const CMPIrc, CMPIStatus *rc)

Error factory service.

Parameters:
mb Pointer to the broker.
msgID A string which uniquely identifies, within the scope of the 'owner' argument, the format of the message.
msg A string which represenst the formatted message.
sev The perceived severity of the error.
pc The probably cause of this error
status Service return status.
Returns:
The newly created Error.

DateTime factory service. Initialized with the time of day.

Parameters:
mb Pointer to the broker.
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created DateTime.
CMPIDateTime*(* _CMPIBrokerEncFT::newDateTimeFromBinary)(const CMPIBroker *mb, CMPIUint64 binTime, CMPIBoolean interval, CMPIStatus *rc)

DateTime factory service. Initialized from <binTime>.

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

DateTime factory service. Is initialized from <utcTime>.

Parameters:
mb Pointer to the broker.
utcTime Date/Time definition in UTC format
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created DateTime.

Instance factory service.

Parameters:
mb Pointer to the broker.
op ObjectPath containing namespace and classname.
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created Instance.
CMPIObjectPath*(* _CMPIBrokerEncFT::newObjectPath)(const CMPIBroker *mb, const char *ns, const char *cn, CMPIStatus *rc)

ObjectPath factory service.

Parameters:
mb Pointer to the broker.
ns Namespace
cn Classname.
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created ObjectPath.
CMPISelectExp*(* _CMPIBrokerEncFT::newSelectExp)(const CMPIBroker *mb, const char *query, const char *lang, CMPIArray **projection, CMPIStatus *st)

SelectExp factory service.

Parameters:
mb Pointer to the broker.
query The select expression.
lang The query language.
projection Output: Projection specification (suppressed when NULL).
rc Output: 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:
mb Pointer to the broker.
data String data
rc Output: 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:
mb Broker this pointer
msgFile The message file identifier.
msgFileHandle Output: 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:
mb Pointer to the broker.
object A valid CMPI object.
rc Output: Service return status (suppressed when NULL).
Returns:
String from representation of <object>.
CMPIStatus(* _CMPIBrokerEncFT::trace)(const CMPIBroker *, CMPILevel level, const char *component, const char *text, const CMPIString *string)

Logs a trace entry. Intended for debugging purposes.

Parameters:
mb The mb argument points to a CMPIBroker structure.
level The level argument describes the level of log message. Levels are defined in Section 4.9.
component The component argument, if not NULL, is the component ID.
text The text argument, if not NULL, is the message text to be logged.
string The 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:
  • /usr/src/startcom/BUILD/pegasus/src/Pegasus/Provider/CMPI/cmpift.h