SysLink API Reference
2.21.03.11
|
Resource Tracker utility module.
Go to the source code of this file.
Data Structures | |
struct | ResTrack_Params |
Structure defining params for creating an instance. More... |
Macros | |
#define | ResTrack_S_SUCCESS 0 |
#define | ResTrack_E_FAIL (-1) |
#define | ResTrack_E_MEMORY (-2) |
#define | ResTrack_E_PID (-3) |
#define | ResTrack_E_NOTFOUND (-4) |
Typedefs | |
typedef Bool(* | ResTrack_Fxn )(Void *ptrA, Void *ptrB) |
Resource compare function type. | |
typedef struct ResTrack_Object * | ResTrack_Handle |
An instance handle type. |
Functions | |
Void | ResTrack_Params_init (ResTrack_Params *params) |
Initialize this config-params structure with supplier-specified defaults before instance creation. | |
ResTrack_Handle | ResTrack_create (ResTrack_Params *params) |
Create a resource tracker object. | |
Void | ResTrack_delete (ResTrack_Handle *handlePtr) |
Delete a resource tracker object. | |
Int | ResTrack_pop (ResTrack_Handle handle, Osal_Pid pid, List_Elem **resPtr) |
Get first element from the resource list. | |
Int | ResTrack_push (ResTrack_Handle handle, Osal_Pid pid, List_Elem *res) |
Add resouce element for given process id. | |
Int | ResTrack_register (ResTrack_Handle handle, Osal_Pid pid) |
Register a new process with the resource tracker. | |
Int | ResTrack_remove (ResTrack_Handle handle, Osal_Pid pid, List_Elem *ref, ResTrack_Fxn cmpFxn, List_Elem **resPtr) |
Remove specific resource object from the resource list. | |
Int | ResTrack_unregister (ResTrack_Handle handle, Osal_Pid pid) |
Unregister the given process with the resource tracker. |
#define ResTrack_S_SUCCESS 0 |
#define ResTrack_E_FAIL (-1) |
#define ResTrack_E_MEMORY (-2) |
#define ResTrack_E_PID (-3) |
#define ResTrack_E_NOTFOUND (-4) |
typedef struct ResTrack_Object* ResTrack_Handle |
An instance handle type.
Void ResTrack_Params_init | ( | ResTrack_Params * | params | ) |
Initialize this config-params structure with supplier-specified defaults before instance creation.
params | Instance config-params structure. |
ResTrack_Handle ResTrack_create | ( | ResTrack_Params * | params | ) |
Create a resource tracker object.
params | Pointer to creation parameters. If NULL is passed, default parameters are used. |
Handle | to the object |
Void ResTrack_delete | ( | ResTrack_Handle * | handlePtr | ) |
Delete a resource tracker object.
handlePtr | Pointer to resource tracker instance handle |
Int ResTrack_pop | ( | ResTrack_Handle | handle, |
Osal_Pid | pid, | ||
List_Elem ** | resPtr | ||
) |
Get first element from the resource list.
handle | Resource tracker instance handle |
pid | Process id |
resPtr | Resource object return pointer, may be NULL |
ResTrack_S_SUCCESS | Operation succeeded |
ResTrack_E_PID | No process object for given id |
Int ResTrack_push | ( | ResTrack_Handle | handle, |
Osal_Pid | pid, | ||
List_Elem * | res | ||
) |
Add resouce element for given process id.
handle | Resource tracker instance handle |
pid | Process id |
res | Resource object to be added |
ResTrack_S_SUCCESS | Operation succeeded |
ResTrack_E_PID | No process object for given id |
Int ResTrack_register | ( | ResTrack_Handle | handle, |
Osal_Pid | pid | ||
) |
Register a new process with the resource tracker.
handle | Resource tracker instance handle |
pid | Process id to register |
ResTrack_S_SUCCESS | Operation succeeded |
ResTrack_E_MEMORY | Memory unavailable |
Int ResTrack_remove | ( | ResTrack_Handle | handle, |
Osal_Pid | pid, | ||
List_Elem * | ref, | ||
ResTrack_Fxn | cmpFxn, | ||
List_Elem ** | resPtr | ||
) |
Remove specific resource object from the resource list.
handle | Resource tracker instance handle |
pid | Process id |
ref | Reference resource object |
cmpFxn | Compare function |
resPtr | Pointer to return resource, may be NULL |
ResTrack_S_SUCCESS | Operation succeeded |
ResTrack_E_PID | No process object for given id |
ResTrack_E_NOTFOUND | No resource found which matches the reference resource |
Int ResTrack_unregister | ( | ResTrack_Handle | handle, |
Osal_Pid | pid | ||
) |
Unregister the given process with the resource tracker.
handle | Resource tracker instance handle |
pid | Process id to unregister |
ResTrack_S_SUCCESS | Operation succeeded |
ResTrack_E_PID | No process object for given id |