le_safeRef.h
Go to the documentation of this file.
1 
183 #ifndef LEGATO_SAFEREF_INCLUDE_GUARD
184 #define LEGATO_SAFEREF_INCLUDE_GUARD
185 
186 //--------------------------------------------------------------------------------------------------
190 //--------------------------------------------------------------------------------------------------
191 typedef struct le_ref_Map* le_ref_MapRef_t;
192 
193 
194 //--------------------------------------------------------------------------------------------------
198 //--------------------------------------------------------------------------------------------------
199 typedef struct le_ref_Iter* le_ref_IterRef_t;
200 
201 
202 //--------------------------------------------------------------------------------------------------
208 //--------------------------------------------------------------------------------------------------
210 (
211  const char* name,
212 
213  size_t maxRefs
214 );
216 
217 
218 //--------------------------------------------------------------------------------------------------
225 //--------------------------------------------------------------------------------------------------
226 void* le_ref_CreateRef
227 (
228  le_ref_MapRef_t mapRef,
229  void* ptr
230 );
231 
232 
233 //--------------------------------------------------------------------------------------------------
241 //--------------------------------------------------------------------------------------------------
242 void* le_ref_Lookup
243 (
244  le_ref_MapRef_t mapRef,
245  void* safeRef
246 );
247 
248 
249 //--------------------------------------------------------------------------------------------------
253 //--------------------------------------------------------------------------------------------------
254 void le_ref_DeleteRef
255 (
256  le_ref_MapRef_t mapRef,
257  void* safeRef
258 );
259 
260 
261 //--------------------------------------------------------------------------------------------------
271 //--------------------------------------------------------------------------------------------------
273 (
274  le_ref_MapRef_t mapRef
275 );
276 
277 
278 //--------------------------------------------------------------------------------------------------
287 //--------------------------------------------------------------------------------------------------
289 (
290  le_ref_IterRef_t iteratorRef
291 );
292 
293 
294 //--------------------------------------------------------------------------------------------------
303 //--------------------------------------------------------------------------------------------------
304 void const * le_ref_GetSafeRef
305 (
306  le_ref_IterRef_t iteratorRef
307 );
308 
309 
310 //--------------------------------------------------------------------------------------------------
319 //--------------------------------------------------------------------------------------------------
320 void const * le_ref_GetValue
321 (
322  le_ref_IterRef_t iteratorRef
323 );
324 
325 
326 #endif // LEGATO_SAFEREF_INCLUDE_GUARD
le_result_t
Definition: le_basics.h:35
struct le_ref_Iter * le_ref_IterRef_t
Definition: le_safeRef.h:199
struct le_ref_Map * le_ref_MapRef_t
Definition: le_safeRef.h:191
le_ref_MapRef_t le_ref_CreateMap(const char *name, size_t maxRefs)
le_ref_IterRef_t le_ref_GetIterator(le_ref_MapRef_t mapRef)
void le_ref_DeleteRef(le_ref_MapRef_t mapRef, void *safeRef)
void * le_ref_CreateRef(le_ref_MapRef_t mapRef, void *ptr)
le_result_t le_ref_NextNode(le_ref_IterRef_t iteratorRef)
void const * le_ref_GetSafeRef(le_ref_IterRef_t iteratorRef)
void * le_ref_Lookup(le_ref_MapRef_t mapRef, void *safeRef)
void const * le_ref_GetValue(le_ref_IterRef_t iteratorRef)