Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kMsgQueue Class Reference

Description

Represents a synchronized FIFO queue with an optional maximum size or count capacity.

Inheritance diagram for kMsgQueue:
Inheritance graph

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...
 
kSize kMsgQueue_ItemSize (kQueue queue)
 Returns the queue element size. 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...
 
- Public Member Functions inherited from kObject
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...
 

Additional Inherited Members


The documentation for this class was generated from the following file: