OpenClovis Logo

Public Attributes | List of all members
ClProvTxnData Struct Reference

The structure is used to pass the job information while calling the object implementer's callback functions. More...

#include <clProvApi.h>

Public Attributes

ClCorTypeT attrDataType
 This is the actual data type of the attribute.
ClCorAttrIdT attrId
 The identifier for the attribute.
ClCorAttrPathPtrT attrPath
 This is pointer to the attribute path structure.
ClCorAttrTypeT attrType
 It is the type of the attribute that is for an array attribute it is CL_COR_ARRAY_ATTR otherwise it is CL_COR_SIMPLE_ATTR.
ClUint32T index
 This is a non-zero value for a array attribute if an index is supplied while submitting the job.
void * pMoId
 It is pointer to the MOID of the managed resource on which the operation is done.
void * pProvData
 It is a pointer to the address containing value of the attribute.
ClCorOpsT provCmd
 The argument provides the operation type of the job.
ClUint32T size
 Size of the data.

Detailed Description

The structure is used to pass the job information while calling the object implementer's callback functions.

These functions include the validate, update and rollback callbacks used for processing the object modification request (create/set/delete) and the read callback for processing the get request on a transient attribute of a managed resource. The object implementer registers the callbacks which will be called in its context if any operation is done on its managed resources.

Member Data Documentation

ClCorTypeT ClProvTxnData::attrDataType

This is the actual data type of the attribute.

It is the data type modeled for the attribute. It can take any value from the enum ClCorTypeT. This is useful in the case of a SET and GET request.

ClCorAttrIdT ClProvTxnData::attrId

The identifier for the attribute.

It is decimal value which identifies an attribute among the list of attributes of the managed resource class. This is useful in the case of a SET and GET operation.

ClCorAttrPathPtrT ClProvTxnData::attrPath

This is pointer to the attribute path structure.

This is useful in the case of a SET and GET request. For the provisioning callback this paramter is always NULL.

ClCorAttrTypeT ClProvTxnData::attrType

It is the type of the attribute that is for an array attribute it is CL_COR_ARRAY_ATTR otherwise it is CL_COR_SIMPLE_ATTR.

This is useful in the case of a SET and GET operation.

ClUint32T ClProvTxnData::index

This is a non-zero value for a array attribute if an index is supplied while submitting the job.

Otherwise it is always zero. For a simple attribute it is always CL_COR_INVALID_ATTR_IDX. This is useful in the case of a SET and GET operation.

void* ClProvTxnData::pMoId

It is pointer to the MOID of the managed resource on which the operation is done.

It is a void pointer, so a user need to cast it to ClCorMOIdPtrT pointer type before start using it. This is useful in the case of all the request types that is CREATE, DELETE, GET and SET operations.

void* ClProvTxnData::pProvData

It is a pointer to the address containing value of the attribute.

For the SET the value of the attribute is present in pProvData, so the user need to dereference it for getting the value. For GET operation on a transient attribute, the latest value should be copied to pProvData. The size of the data to be copied to or from is given by the "size" field of this structure.

ClCorOpsT ClProvTxnData::provCmd

The argument provides the operation type of the job.

It can be one of the CL_COR_OP_SET, CL_COR_OP_CREATE, CL_COR_OP_CREATE_AND_SET or CL_COR_OP_DELETE or CL_COR_OP_GET.

ClUint32T ClProvTxnData::size

Size of the data.

This is useful only in case of SET and GET job. In case of SET operation, for getting the value of the attribute only this element should be used. For a get operation, the value copied to the pProvData should be equal to "size".


Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen