160 IRES_YieldContextHandle algYieldContext, IRES_YieldArgs yieldArgs);
IRES_Status
IRES_Status defines the standard error and success codes returned by IRES APIs.
Definition: ires_common.h:57
Void(* IRES_YieldFxn)(IRES_YieldResourceType resourceType, IRES_YieldContextHandle algYieldContext, IRES_YieldArgs yieldArgs)
The 'yield function' pointer and 'yield arguments' are supplied to an algorithm during its IRES inter...
Definition: ires.h:159
Algorithm instance object definition.
Definition: ialg.h:159
IRES_Handle resourceHandle
Definition: ires.h:97
IRES Resource Protocol Definitions - IRES Resource.
IRES_YieldContext * IRES_YieldContextHandle
Definition: ires.h:139
IRES_ContextSaveFxn contextSave
Definition: ires.h:110
IRES_ContextRestoreFxn contextRestore
Definition: ires.h:125
IRES_Status(* activateAllResources)(IALG_Handle handle)
Resource Activation call to grant the algorithm instance exclusive access to all resources it acquire...
Definition: ires.h:246
IALG_Handle algHandle
Definition: ires.h:89
IRES_Status(* reinitResources)(IALG_Handle handle, IRES_ResourceDescriptor *resourceDescriptor, IRES_YieldFxn yieldFxn, IRES_YieldArgs yieldArgs)
Re-assignment function to grant the algorithm instance a list of "modified" IRES resources. The algorithm may choose to not support the re-assignment and indicate this by returning failure. In case of success the algorithm updates its internal state to reflect the new resource information, but may not use or access the resource state until the resource is activated via the activateResource call.
Definition: ires.h:217
Void * contextArgs
Definition: ires.h:134
IRES_Status(* getResourceDescriptors)(IALG_Handle handle, IRES_ResourceDescriptor *resourceDescriptors)
Query function to obtain the list of IRES resources requested by the algorithm instance.
Definition: ires.h:180
IRES_Obj holds the private state associated with each logical resource.
Definition: ires_common.h:176
IRES_Status(* activateResource)(IALG_Handle handle, IRES_Handle resourceHandle)
Resource Activation call to grant the algorithm instance exclusive access to the potentially shared r...
Definition: ires.h:237
Void(* IRES_ContextSaveFxn)(IALG_Handle algHandle, Void *contextArgs)
Definition: ires.h:75
IRES_Status(* deactivateAllResources)(IALG_Handle handle)
Resource Deactivation call to revoke the algorithm instance's exclusive access to ALL shared resource...
Definition: ires.h:263
struct IRES_Fxns IRES_Fxns
These fxns are used to query/grant the resources requested by the algorithm at initialization time...
IRES_Status(* deactivateResource)(IALG_Handle handle, IRES_Handle resourceHandle)
Resource Deactivation call to revoke the algorithm instance's exclusive access to the potentially sha...
Definition: ires.h:254
struct IRES_YieldContext IRES_YieldContext
Specifies the algorithm specific handles and context save & restore function pointers and arguments t...
Descriptor to Logical Resource.
Definition: ires_common.h:122
These fxns are used to query/grant the resources requested by the algorithm at initialization time...
Definition: ires.h:168
Int32(* numResourceDescriptors)(IALG_Handle handle)
Query function to obtain the number of IRES resources requested by the algorithm instance, which is also the number of resource descriptors that must be passed to the getResourceDescriptors() function.
Definition: ires.h:190
Specifies the algorithm specific handles and context save & restore function pointers and arguments t...
Definition: ires.h:84
IRES_Status(* initResources)(IALG_Handle handle, IRES_ResourceDescriptor *resourceDescriptor, IRES_YieldFxn yieldFxn, IRES_YieldArgs yieldArgs)
Assignment function to grant the algorithm instance the list of IRES resources it requested...
Definition: ires.h:203
Void * IRES_YieldArgs
Definition: ires.h:140
Void(* IRES_ContextRestoreFxn)(IALG_Handle algHandle, Void *contextArgs)
Definition: ires.h:77
Void * implementationId
Unique pointer that identifies the module implementing this interface.
Definition: ires.h:174
IRES_Status(* deinitResources)(IALG_Handle handle, IRES_ResourceDescriptor *resourceDescriptor)
Deinitialization function to revoke back the resources that have been granted to the algorithm instan...
Definition: ires.h:225
IRES_YieldResourceType
Definition: ires.h:60