framework/c/inc/le_safeRef.h

Go to the documentation of this file.

#ifndef LEGATO_SAFEREF_INCLUDE_GUARD
#define LEGATO_SAFEREF_INCLUDE_GUARD

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_ref_Map* le_ref_MapRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_ref_Iter* le_ref_IterRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_ref_MapRef_t le_ref_CreateMap
(
    const char* name,   

    size_t      maxRefs 

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void* le_ref_CreateRef
(
    le_ref_MapRef_t mapRef, 
    void*           ptr     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void* le_ref_Lookup
(
    le_ref_MapRef_t mapRef, 
    void*           safeRef 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_ref_DeleteRef
(
    le_ref_MapRef_t mapRef, 
    void*           safeRef 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_ref_IterRef_t le_ref_GetIterator
(
    le_ref_MapRef_t mapRef 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ref_NextNode
(
    le_ref_IterRef_t iteratorRef 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void const * le_ref_GetSafeRef
(
    le_ref_IterRef_t iteratorRef 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void const * le_ref_GetValue
(
    le_ref_IterRef_t iteratorRef 
);


#endif // LEGATO_SAFEREF_INCLUDE_GUARD