resourcemgr.h

#ifndef __RESOURCEMGR_H__
#define __RESOURCEMGR_H__
/*=============================================================================  
     Module  : resourcesmgr.h
     Purpose : Define a "generic" handle based resource manager object.
     Author  : Doug Ehlenberger, CNIC Mt. Sinai School of Medicine
               
=============================================================================*/
#include "configure.h"
#include "handle.h"


typedef vVOID ( *CleanResourceFunc_t )( vVOID *resource );

typedef struct tagResourceManager
   {  
   vVOID             **resources;
   vSIZE               numResources;
   vINDEX             *freeIndices;   
   vSIZE               numFreeIndices;     
   vMAGIC             *magicNumbers;
   vSIZE              *referenceCounts;
   CleanResourceFunc_t cleanFunc_t;
   }
   ResourceManager;


/*-----------------------------------------------------------------------------
   Allocates a resource manager structure that can issue initially numResources
   handles. Returns a pointer to the structure or NULL on failure.
-----------------------------------------------------------------------------*/
ResourceManager* CreateResourceManager
   (
   vSIZE numResources
   );


/*-----------------------------------------------------------------------------
   Free the memory used by the resource manager. If the vDEBUG flag is set, the 
   function checks if all handles have been released.
-----------------------------------------------------------------------------*/
vVOID DestroyResourceManager
   (
   ResourceManager **manager
   );


/*-----------------------------------------------------------------------------
   Use before calling DestroyResourceManager to check if all handles 
   were released.
-----------------------------------------------------------------------------*/
vVOID DebugResourceManager
   (
   ResourceManager *manager,
   vSTRING          debugDescription          
   );


/*-----------------------------------------------------------------------------
   Increase the number of handles the manager can issue.
   Upon failure the original manager structure is unaltered. 
   On success all handles are still valid after call.
-----------------------------------------------------------------------------*/
vBOOL IncreaseResourceCapacity
   (
   ResourceManager *manager, 
   vSIZE            increment
   );


vBOOL HasMoreHandles
   (
   ResourceManager *manager
   );


/* Returns the current number of resources in existence, NOT the resource capacity
   of the manager. */
vSIZE GetNumResources
   (
   ResourceManager *manager
   );


vHANDLE GetHandle
   (
   ResourceManager *manager
   );


vHANDLE ReferenceHandle
   (
   ResourceManager *manager,
   vHANDLE          handle
   );


vSIZE GetReferenceCount
   (
   ResourceManager *manager,
   vHANDLE          handle
   );


vVOID ReleaseHandle
   (
   ResourceManager *manager, 
   vHANDLE          handle
   );


vBOOL IsValidHandle
   (
   ResourceManager *manager,
   vHANDLE          handle
   );


vVOID* GetResource
   (
   ResourceManager *manager, 
   vHANDLE          handle
   );


vVOID SetResource
   (
   ResourceManager *manager,
   vHANDLE          handle,
   vVOID           *resource
   );


#endif /* __RESOURCEMGR_H__ */

---