|
Zen API
|
|
Zen API
|
Represents a synchronized FIFO queue with an optional maximum size or count capacity.
Inheritance diagram for kMsgQueue:Public Member Functions | |
| kStatus | kMsgQueue_Add (kMsgQueue queue, void *item) |
| Adds an item to the queue. More... | |
| kStatus | kMsgQueue_Clear (kMsgQueue queue) |
| Removes all items from the queue. More... | |
| kStatus | kMsgQueue_Construct (kMsgQueue *queue, kType itemType, kAlloc allocator) |
| Constructs a kMsgQueue object. More... | |
| kSize | kMsgQueue_Count (kMsgQueue queue) |
| Reports the current count of queue items. More... | |
| kSize | kMsgQueue_DataSize (kMsgQueue queue) |
| Reports the current amount of data stored in the queue (in bytes). More... | |
| k64u | kMsgQueue_DropCount (kMsgQueue queue) |
| Reports the count of dropped items. More... | |
| kType | kMsgQueue_ItemType (kMsgQueue queue) |
| Reports the type of element stored in the queue. More... | |
| kSize | kMsgQueue_MaxCount (kMsgQueue queue) |
| Reports the maximum count of items in the queue. More... | |
| kSize | kMsgQueue_MaxSize (kMsgQueue queue) |
| Reports the maximum total data size of all items in the queue. More... | |
| kStatus | kMsgQueue_Purge (kMsgQueue queue) |
| Disposes any elements in the queue and sets the count of queue items to zero. More... | |
| kStatus | kMsgQueue_Remove (kMsgQueue queue, void *item, k64u timeout) |
| Removes an item from the queue. More... | |
| kStatus | kMsgQueue_Reserve (kMsgQueue queue, kSize count) |
| Reserves memory for the specified number of items. More... | |
| kStatus | kMsgQueue_SetDropHandler (kMsgQueue queue, kMsgQueueDropFx onDrop, kPointer receiver) |
| Sets the callback used when dropping an item. More... | |
| kStatus | kMsgQueue_SetMaxCount (kMsgQueue queue, kSize count) |
| Adjusts the maximum count of items retained by the queue. More... | |
| kStatus | kMsgQueue_SetMaxSize (kMsgQueue queue, kSize size) |
| Adjusts the maximum amount of data retained by the queue. More... | |
| kAlloc | kObject_Alloc (kObject object) |
| Gets the memory allocator associated with this object. More... | |
| kStatus | kObject_Clone (kObject *object, kObject source, kAlloc allocator) |
| Constructs a new object by copying an existing object, including any aggregated child elements. More... | |
| kStatus | kObject_Destroy (kObject object) |
| Destroys the object. More... | |
| kStatus | kObject_Dispose (kObject object) |
| Destroys the object and any aggregated child elements. More... | |
| kBool | kObject_Equals (kObject object, kObject other) |
| Determines whether the object is equal to another object. More... | |
| kSize | kObject_HashCode (kObject object) |
| Gets a hash code representing the state of this object. More... | |
| kBool | kObject_Is (kObject object, kType type) |
| Determines whether this object is an instance of the specified type. More... | |
| kBool | kObject_IsShared (kObject object) |
| Reports whether the object is currently shared (reference count greater than one). More... | |
| kStatus | kObject_SetPool (kObject object, kObjectPool pool) |
| Sets the object pool associated with this object. More... | |
| kStatus | kObject_Share (kObject object) |
| Increments the reference count associated with this object. More... | |
| kSize | kObject_Size (kObject object) |
| Estimates the memory consumed by this object, including any aggregated child elements. More... | |
| kType | kObject_Type (kObject object) |
| Returns the type of the object. More... | |
Adds an item to the queue.
If queue capacity is exceeded, the oldest item in the queue will be removed. If a drop handler is installed, the handler will be called; otherwise, if the queue is an object container, then kObject_Dispose will be used to dispose the item.
If the operation status returned by this function indicates an error, it is the responsibility of the caller to dispose the item (if appropriate).
| queue | Queue object. |
| item | Item to be added. |
Removes all items from the queue.
This method does not call the drop handler when removing items.
| queue | Queue object. |
Constructs a kMsgQueue object.
| queue | Receives a handle to the constructed object. |
| itemType | Type of list element (must be a reference type). |
| allocator | Memory allocator (or kNULL for default). |
Reports the current count of queue items.
| queue | Queue object. |
Reports the current amount of data stored in the queue (in bytes).
| queue | Queue object. |
Reports the count of dropped items.
| queue | Queue object. |
Reports the type of element stored in the queue.
| queue | Queue object. |
Reports the maximum count of items in the queue.
| queue | Queue object. |
Reports the maximum total data size of all items in the queue.
| queue | Queue object. |
Disposes any elements in the queue and sets the count of queue items to zero.
This method does not call the drop handler when removing items.
| queue | Queue object. |
Removes an item from the queue.
| queue | Queue object. |
| item | Receives removed item (can be kNULL). |
| timeout | Timeout (microseconds). |
Reserves memory for the specified number of items.
| queue | Queue object. |
| count | Count of items for which to reserve capacity. |
Sets the callback used when dropping an item.
If a handler is not set, and the queue contains objects, then dropped objects are passed to kObject_Dispose.
| queue | Queue object. |
| onDrop | Callback function. |
| receiver | Callback context. |
Adjusts the maximum count of items retained by the queue.
| queue | Queue object. |
| count | Maximum total count of all data items in queue. |
Adjusts the maximum amount of data retained by the queue.
| queue | Queue object. |
| size | Maximum total recursive size of all data items in queue, in bytes. |
Gets the memory allocator associated with this object.
Most objects are constructed with an allocator, which is used to allocate the memory required by the object. Objects retain a reference to this allocator to enable further allocations and to free memory when the object is destroyed.
| object | Object. |
Constructs a new object by copying an existing object, including any aggregated child elements.
If the source object is an object collection (e.g. kArrayList<kString>), any aggregated child objects are also cloned. In this case, the kObject_Dispose method can be used to free the cloned collection and its associated elements.
This method will fail if the source object (or an aggregated child element) does not support cloning.
| object | Receives the constructed object. |
| source | Source object. |
| allocator | Memory allocator (or kNULL for default). |
Destroys the object.
The kObject_Destroy method destroys the object itself and any resources that are owned by the object. See Object Destruction for more information.
When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.
| object | Object (or kNULL). |
Destroys the object and any aggregated child elements.
The kObject_Dispose method destroys the object itself, any resources that are owned by the object, and if the object represents a collection of objects, any child objects in the collection. See Object Destruction for more information.
When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.
| object | Object (or kNULL). |
Determines whether the object is equal to another object.
By default, objects are compared by reference; objects are considered equal if the given handles refer to the same object instance. However, some classes override the Equals method to provide a more meaningful comparison (e.g. kString).
| object | Object. |
| other | Object for comparison. |
Gets a hash code representing the state of this object.
By default, objects return a hash code based on the object handle value. However, some classes override the HashCode method to provide a more useful hash (e.g. kString).
| object | Object. |
Determines whether this object is an instance of the specified type.
This function compares the type of this object with the given type. An object is considered to be an instance of a given type if a) the type represents a class and this object inherits from (or instantiates) that class, or b) the type represents an interface and this object implements the interface.
| object | Object. |
| type | Type. |
Reports whether the object is currently shared (reference count greater than one).
Objects are initialized with a reference count of one. The kObject_Share method can be used to increment the reference count. The kObject_Destroy and kObject_Dispose methods decrease the reference count, and when the reference count reaches zero, the object is actually destroyed/disposed.
This method can be used to determine if the reference count of an object is currently greater than one.
This method is thread-safe.
| object | Object. |
|
inherited |
Sets the object pool associated with this object.
Object pools can be used to implement custom lifecycle management. If an object has an assigned pool, then the kObjectPool_Reclaim method will be called just prior to destruction, to provide an opportunity for the object to be reclaimed.
| object | Object. |
| pool | Pool object (or kNULL to clear the pool assignment). |
Increments the reference count associated with this object.
This method is thread-safe.
| object | Object. |
Estimates the memory consumed by this object, including any aggregated child elements.
This method can be optionally overridden by kObject-derived classes to report the amount of memory consumed by an object. The default implementation reports only the size of the class instance (additional allocations performed by the class are excluded).
| object | Object. |
Returns the type of the object.
Each object is an instance of a specific class type. The type handle returned by this function can be used to learn about the class.
| object | Object. |
