MAK Legion API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Functions
c_ownership.h File Reference

Go to the source code of this file.

Typedefs

typedef void(* C_DivestitureRequestCallback )(void *user, TransactionId transactionID, const GlobalId *globalIds, UInt32 idCount, const char *privateData, UInt32 dataSize)
 Ownership callback function Prototypes. More...
 
typedef void(* C_RequestRejectedCallback )(void *user, TransactionId transactionID, const GlobalId *globalIds, UInt32 idCount, const char *privateData, UInt32 size)
 
typedef void(* C_AcquiredCallback )(void *user, TransactionId transactionID, const GlobalId *globalIds, UInt32 idCount, const char *privateData, UInt32 size)
 
typedef void(* C_InitiateAcquisitionRequestCallback )(void *user, TransactionId transactionID, const GlobalId *globalIds, UInt32 idCount, const char *privateData, UInt32 dataSize)
 
typedef void(* C_InitiateAcquisitionResultCallback )(void *user, TransactionId transactionID, const GlobalId *globalIds, UInt32 idCount, unsigned int result, const char *exceptionDescription)
 

Functions

LEGIONNETRUNTIME_DLL TransactionId legion_ownership_requestAcquisition (OwnershipManagerHandle manager, const GlobalId *globalIds, UInt32 count, const char *privateData, UInt32 dataSize, TransactionId transactionID)
 
LEGIONNETRUNTIME_DLL void legion_ownership_rejectDivestitureRequest (OwnershipManagerHandle manager, TransactionId transactionID, const GlobalId *globalIds, UInt32 count, const char *privateData, UInt32 dataSize)
 
LEGIONNETRUNTIME_DLL void legion_ownership_divest (OwnershipManagerHandle manager, TransactionId transactionID, const GlobalId *globalIds, UInt32 count, const char *privateData, int dataSize)
 
LEGIONNETRUNTIME_DLL TransactionId legion_ownership_requestInitiateAcquisition (OwnershipManagerHandle manager, ClientId acquiringClientId, const GlobalId *globalIds, UInt32 count, const char *privateData, UInt32 dataSize)
 
LEGIONNETRUNTIME_DLL void legion_ownership_initateAcquisitionRequestResponse (OwnershipManagerHandle manager, TransactionId transactionID, const GlobalId *globalIds, UInt32 count, unsigned int result, const char *exceptionDescription="")
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_addDivestitureRequestCallback (OwnershipManagerHandle manager, C_DivestitureRequestCallback func, void *usr)
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_removeDivestitureRequestCallback (OwnershipManagerHandle manager, C_DivestitureRequestCallback func, void *usr)
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_addRequestRejectedCallback (OwnershipManagerHandle manager, C_RequestRejectedCallback func, void *usr)
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_removeRequestRejectedCallback (OwnershipManagerHandle manager, C_RequestRejectedCallback func, void *usr)
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_addAcquiredCallback (OwnershipManagerHandle manager, C_AcquiredCallback func, void *usr)
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_removeAcquiredCallback (OwnershipManagerHandle manager, C_AcquiredCallback func, void *usr)
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_addInitiateAcquisitionRequestCallback (OwnershipManagerHandle manager, C_InitiateAcquisitionRequestCallback func, void *usr)
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_removeInitiateAcquisitionRequestCallback (OwnershipManagerHandle manager, C_InitiateAcquisitionRequestCallback func, void *usr)
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_addInitiateAcquisitionResultCallback (OwnershipManagerHandle manager, C_InitiateAcquisitionResultCallback func, void *usr)
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_removeInitiateAcquisitionResultCallback (OwnershipManagerHandle manager, C_InitiateAcquisitionResultCallback func, void *usr)
 

Typedef Documentation

typedef void(* C_AcquiredCallback)(void *user, TransactionId transactionID, const GlobalId *globalIds, UInt32 idCount, const char *privateData, UInt32 size)

Callback that is called when an acquisition request is accepted and ownership has been acquired

typedef void(* C_DivestitureRequestCallback)(void *user, TransactionId transactionID, const GlobalId *globalIds, UInt32 idCount, const char *privateData, UInt32 dataSize)

Ownership callback function Prototypes.

Callback to handle requests to divest ownership of a given set of attribute instances The provided transaction ID is used in response to the associated request

typedef void(* C_InitiateAcquisitionRequestCallback)(void *user, TransactionId transactionID, const GlobalId *globalIds, UInt32 idCount, const char *privateData, UInt32 dataSize)

Callback to handle requests to initiate an ownership acquisition of a given set of attribute instances from the given owner The provided transaction ID is used in response to the associated request

typedef void(* C_InitiateAcquisitionResultCallback)(void *user, TransactionId transactionID, const GlobalId *globalIds, UInt32 idCount, unsigned int result, const char *exceptionDescription)

Callback that is called to provide result of initiating ownership acquisition on another client

typedef void(* C_RequestRejectedCallback)(void *user, TransactionId transactionID, const GlobalId *globalIds, UInt32 idCount, const char *privateData, UInt32 size)

Callback that is called when an acquisition request is rejected

Function Documentation

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_addAcquiredCallback ( OwnershipManagerHandle  manager,
C_AcquiredCallback  func,
void *  usr 
)

Add and register acquired callback

Parameters
[in]managerThe handle of ownership manager
[in]funcA callback function to add
[in]usrUser data passed to the callback function
See Also
C_AcquiredCallback
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_addDivestitureRequestCallback ( OwnershipManagerHandle  manager,
C_DivestitureRequestCallback  func,
void *  usr 
)

Add and register divestiture request callback

Parameters
[in]managerThe handle of ownership manager
[in]funcA callback function to add
[in]usrUser data passed to the callback function
See Also
C_DivestitureRequestCallback
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_addInitiateAcquisitionRequestCallback ( OwnershipManagerHandle  manager,
C_InitiateAcquisitionRequestCallback  func,
void *  usr 
)

Add and register initiate acquisition request callback

Parameters
[in]managerThe handle of ownership manager
[in]funcA callback function to add
[in]usrUser data passed to the callback function
See Also
C_InitiateAcquisitionRequestCallback
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_addInitiateAcquisitionResultCallback ( OwnershipManagerHandle  manager,
C_InitiateAcquisitionResultCallback  func,
void *  usr 
)

Add and register initiate acquisition result callback

Parameters
[in]managerThe handle of ownership manager
[in]funcA callback function to add
[in]usrUser data passed to the callback function
See Also
C_InitiateAcquisitionResultCallback
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_addRequestRejectedCallback ( OwnershipManagerHandle  manager,
C_RequestRejectedCallback  func,
void *  usr 
)

Add and register request rejected callback

Parameters
[in]managerThe handle of ownership manager
[in]funcA callback function to add
[in]usrUser data passed to the callback function
See Also
C_RequestRejectedCallback
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
LEGIONNETRUNTIME_DLL void legion_ownership_divest ( OwnershipManagerHandle  manager,
TransactionId  transactionID,
const GlobalId *  globalIds,
UInt32  count,
const char *  privateData,
int  dataSize 
)

Divest ownership of a previously requested divestiture associated with the given transaction ID. The given private data is provided to the requesting client upon ownership acquisition

Parameters
[in]managerThe handle of ownership manager
[in]transactionIDThe transaction ID of the request
[in]globalIdsThe global ids
[in]countThe total number of global ids
[in]privateDataThe private data of the client
[in]dataSizeThe size of private data
LEGIONNETRUNTIME_DLL void legion_ownership_initateAcquisitionRequestResponse ( OwnershipManagerHandle  manager,
TransactionId  transactionID,
const GlobalId *  globalIds,
UInt32  count,
unsigned int  result,
const char *  exceptionDescription = "" 
)

Provide results to initiated request. Supply a description of exception if one occurs e.g. problems with private data or creating write repository, etc.

Parameters
[in]managerThe handle of ownership manager
[in]transactionIDThe transaction ID of the request
[in]globalIdsThe global ids of the request
[in]countThe total number of global ids
[in]resultThe result
[in]exceptionDescriptionThe exception description
LEGIONNETRUNTIME_DLL void legion_ownership_rejectDivestitureRequest ( OwnershipManagerHandle  manager,
TransactionId  transactionID,
const GlobalId *  globalIds,
UInt32  count,
const char *  privateData,
UInt32  dataSize 
)

Reject an ownership divestiture request with the given transaction ID

Parameters
[in]managerThe handle of ownership manager
[in]transactionIDThe transaction ID of the request
[in]globalIdsThe global ids
[in]countThe total number of global ids
[in]privateDataThe private data of the client
[in]dataSizeThe size of private data
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_removeAcquiredCallback ( OwnershipManagerHandle  manager,
C_AcquiredCallback  func,
void *  usr 
)

Remove and unregister acquired callback

Parameters
[in]managerThe handle of ownership manager
[in]funcA callback function to add
[in]usrUser data passed to the callback function
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_removeDivestitureRequestCallback ( OwnershipManagerHandle  manager,
C_DivestitureRequestCallback  func,
void *  usr 
)

Remove and unregister divestiture request callback

Parameters
[in]managerThe handle of ownership manager
[in]funcA callback function to add
[in]usrUser data passed to the callback function
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_removeInitiateAcquisitionRequestCallback ( OwnershipManagerHandle  manager,
C_InitiateAcquisitionRequestCallback  func,
void *  usr 
)

Remove and unregister initiate acquisition request callback

Parameters
[in]managerThe handle of ownership manager
[in]funcA callback function to add
[in]usrUser data passed to the callback function
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_removeInitiateAcquisitionResultCallback ( OwnershipManagerHandle  manager,
C_InitiateAcquisitionResultCallback  func,
void *  usr 
)

Remove and unregister initiate acquisition result callback

Parameters
[in]managerThe handle of ownership manager
[in]funcA callback function to add
[in]usrUser data passed to the callback function
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_ownership_removeRequestRejectedCallback ( OwnershipManagerHandle  manager,
C_RequestRejectedCallback  func,
void *  usr 
)

Remove and unregister request rejected callback

Parameters
[in]managerThe handle of ownership manager
[in]funcA callback function to add
[in]usrUser data passed to the callback function
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
LEGIONNETRUNTIME_DLL TransactionId legion_ownership_requestAcquisition ( OwnershipManagerHandle  manager,
const GlobalId *  globalIds,
UInt32  count,
const char *  privateData,
UInt32  dataSize,
TransactionId  transactionID 
)

Request ownership acquisition for the root parent attribute set with the given instance handles. All extensions for each attribute set (and decedent attribute sets) will be included in the request.

Parameters
[in]managerThe handle of ownership manager
[in]globalIdsThe entities global ids
[in]countThe total number of global ids to request ownership acquisition
[in]privateDataThe private data of the client
[in]dataSizeThe size of private data
[in]transactionIDThe transaction ID of the request
Returns
TransactionId A transaction ID for the request (will be delivered in corresponding ownershipAcquired callback)
LEGIONNETRUNTIME_DLL TransactionId legion_ownership_requestInitiateAcquisition ( OwnershipManagerHandle  manager,
ClientId  acquiringClientId,
const GlobalId *  globalIds,
UInt32  count,
const char *  privateData,
UInt32  dataSize 
)

Request another client initiate an ownership acquisition of the given attributes Return a transaction ID for the request (will be delivered in corresponding InitiateAcquisitionResult callback) All extensions for each attribute set(and decedent attribute sets) will be included in the request.

Parameters
[in]managerThe handle of ownership manager
[in]acquiringClientIdThe acquiring client Id
[in]globalIdsThe global ids
[in]countThe total number of global ids
[in]privateDataThe private data of the client
[in]dataSizeThe size of private data
Returns
TransactionId A transaction ID for the request(will be delivered in corresponding ownershipAcquired callback)
Document ID: Generated on Mon Mar 8 15:11:30 EST 2021 from SVN revision 225633
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)