IRESMAN_Fxns Struct Reference [Resource manager interface]

#include <iresman.h>

Collaboration diagram for IRESMAN_Fxns:

Data Fields
String(*	getProtocolName )()
	Function to query the name of the protocol.
IRES_ProtocolRevision *(*	getProtocolRevision )()
	Function to query the revision of hte protocol.
IRES_Status(*	init )(IRESMAN_Params *initArgs)
	Function to create and initialize the device specific resource manager implementation.
IRES_Status(*	exit )()
	Function called when RESMAN is no longer needed. Use it to free memory allocated etc.
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.
IRES_Status(*	freeHandle )(IALG_Handle algHandle, IRES_Handle resourceHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId)
	Frees handles back to the resource pool.

---

Field Documentation

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.

Return values:

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.

Parameters:

[in]

initArgs

Initialization arguments maybe interpreted by device specific implementation

Return values:

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.

Return values:

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.

Parameters:

[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.

Parameters:

[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

Return values:

IRESMAN_EOK

Success IRESMAN_EERROR Handle could not be freed

---

The documentation for this struct was generated from the following file:

• iresman.h