Framework Components Application Programming Interface (API)
fc-v04
|
#include <iresman.h>
Data Fields | |
String(* | getProtocolName )() |
Function to query the name of the protocol. More... | |
IRES_ProtocolRevision *(* | getProtocolRevision )() |
Function to query the revision of hte protocol. More... | |
IRES_Status(* | init )(IRESMAN_Params *initArgs) |
Function to create and initialize the device specific resource manager implementation. More... | |
IRES_Status(* | exit )() |
Function called when RESMAN is no longer needed. Use it to free memory allocated etc. More... | |
IRES_Handle(* | getHandle )(IALG_Handle algHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId, IRES_Status *status) |
Function that returns the IRES_Handle to resource requested using the IRES_ProtocolArgs. More... | |
IRES_Status(* | freeHandle )(IALG_Handle algHandle, IRES_Handle resourceHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId) |
Frees handles back to the resource pool. More... | |
Void(* | activateResource )(IALG_Handle algHandle, IRES_Fxns *resFxns) |
Void(* | deactivateResource )(IALG_Handle algHandle, IRES_Fxns *resFxns) |
String(* IRESMAN_Fxns::getProtocolName) () |
Function to query the name of the protocol.
IRES_ProtocolRevision*(* IRESMAN_Fxns::getProtocolRevision) () |
Function to query the revision of hte protocol.
Pointer | to the protocol revision structure |
IRES_Status(* IRESMAN_Fxns::init) (IRESMAN_Params *initArgs) |
Function to create and initialize the device specific resource manager implementation.
[in] | initArgs | Initialization arguments maybe interpreted by device specific implementation |
IRESMAN_EOK | Success IRESMAN_EEXISTS RESMAN already initialized IRESMAN_EERROR RESMAN could not be initialized |
IRES_Status(* IRESMAN_Fxns::exit) () |
Function called when RESMAN is no longer needed. Use it to free memory allocated etc.
IRESMAN_EOK | Success IRESMAN_ENOINIT RESMAN not initialized IRESMAN_EERROR RESMAN could not be reset |
IRES_Handle(* IRESMAN_Fxns::getHandle) (IALG_Handle algHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId, IRES_Status *status) |
Function that returns the IRES_Handle to resource requested using the IRES_ProtocolArgs.
[in] | algHandle | Handle of the algorithm that is requesting the resources |
[in] | resDesc | Arguments to be interpreted by IRES_Manager implementation to determine actual physical resources to obtain |
[in] | scratchGroupId | Scratch Group Id where resources should be allocated |
[out] | status | IRESMAN_EOK Success IRESMAN_ENORESOURCE Resource unavailable IRESMAN_EERROR Error obtaining handles |
IRES_Status(* IRESMAN_Fxns::freeHandle) (IALG_Handle algHandle, IRES_Handle resourceHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId) |
Frees handles back to the resource pool.
[in] | algHandle | Handle of the algorithm that is releasing the resources |
[in] | resourceHandle | Handle that is to be released |
[in] | resDesc | Arguments that help determine which resources to free |
IRESMAN_EOK | Success IRESMAN_EERROR Handle could not be freed |
Void(* IRESMAN_Fxns::activateResource) (IALG_Handle algHandle, IRES_Fxns *resFxns) |
Void(* IRESMAN_Fxns::deactivateResource) (IALG_Handle algHandle, IRES_Fxns *resFxns) |