Zen API

- Home
- Help Topics
- Types by Category
- All Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups Pages
kObjectPool.h
Go to the documentation of this file.
1 /**
2 * @file kObjectPool.h
3 * @brief Declares the kObjectPool interface.
4 *
5 * @internal
6 * Copyright (C) 2013-2014 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef K_API_OBJECT_POOL_H
11 #define K_API_OBJECT_POOL_H
12
13 #include <kApi/kApiDef.h>
14
15 kBeginHeader()
16
17 /**
18 * @interface kObjectPool
19 * @ingroup kApi
20 * @brief Supports reclaiming objects upon destruction.
21 * @see kObject_SetPool, kObject_Destroy, kObject_Dispose
22 */
23 //typedef kObject kObjectPool; --forward-declared in kApiDef.x.h
24
25 /**
26 * Receives an object just prior to its destruction.
27 *
28 * @public @memberof kObjectPool
29 * @param pool Pool object.
30 * @param object Object to be reclaimed.
31 * @return Operation status.
32 * @see kObject_SetPool, kObject_Destroy, kObject_Dispose
33 */
34 kFx(kStatus) kObjectPool_Reclaim(kObjectPool pool, kObject object);
35
36 kEndHeader()
37
38 #include <kApi/Utils/kObjectPool.x.h>
39
40 #endif
kObjectPool::kObjectPool_Reclaim
kStatus kObjectPool_Reclaim(kObjectPool pool, kObject object)
Receives an object just prior to its destruction.
kObjectPool
Supports reclaiming objects upon destruction.
kApiDef.h
Essential API declarations.
kObject
Root of all class types in the Zen type system.
kStatus
Represents an enumeration of error codes.