kMsgQueue.h

Go to the documentation of this file.

#ifndef K_API_MSG_QUEUE_H
#define K_API_MSG_QUEUE_H

#include <kApi/kApiDef.h>

typedef struct kMsgQueueDropArgs
{
    void* item;       
} kMsgQueueDropArgs; 

typedef k32s kMsgQueuePurgeOption; 

#define kMSG_QUEUE_PURGE_OPTION_NULL                        (0x0)       
#define kMSG_QUEUE_PURGE_OPTION_PRESERVE_CRITICAL           (0x1)       
#define kMSG_QUEUE_PURGE_OPTION_USE_HANDLER                 (0x2)       
#define kMSG_QUEUE_PURGE_OPTION_DISPOSE_ITEMS               (0x4)       
#define kMSG_QUEUE_PURGE_OPTION_COUNT_DROPS                 (0x8)       

typedef k32s kMsgQueueItemOption; 

#define kMSG_QUEUE_ITEM_OPTION_NULL                         (0x0)       
#define kMSG_QUEUE_ITEM_OPTION_CRITICAL                     (0x1)       
#define kMSG_QUEUE_ITEM_OPTION_INBAND                       (0x2)       

typedef kStatus (kCall *kMsgQueueDropFx) (kPointer receiver, kMsgQueue queue, kMsgQueueDropArgs* args); 

#include <kApi/Threads/kMsgQueue.x.h>

//typedef kObject kMsgQueue;          // --forward-declared in kApiDef.x.h 

kFx(kStatus) kMsgQueue_Construct(kMsgQueue* queue, kType itemType, kAlloc allocator); 

kFx(kStatus) kMsgQueue_SetMaxSize(kMsgQueue queue, kSize size);

kFx(kStatus) kMsgQueue_SetMaxCount(kMsgQueue queue, kSize count);

kFx(kStatus) kMsgQueue_Reserve(kMsgQueue queue, kSize count);

kFx(kStatus) kMsgQueue_SetDropHandler(kMsgQueue queue, kMsgQueueDropFx onDrop, kPointer receiver);

kFx(kStatus) kMsgQueue_Add(kMsgQueue queue, void* item);

#define kMsgQueue_AddT(kMsgQueue_queue, TPtr_item) \
    xkMsgQueue_AddT(kMsgQueue_queue, TPtr_item, sizeof(*(TPtr_item)))

kFx(kStatus) kMsgQueue_AddEx(kMsgQueue queue, void* item, kMsgQueueItemOption options);

#define kMsgQueue_AddExT(kMsgQueue_queue, TPtr_item, kMsgQueueItemOption_options) \
    xkMsgQueue_AddExT(kMsgQueue_queue, TPtr_item, kMsgQueueItemOption_options, sizeof(*(TPtr_item)))

kFx(kStatus) kMsgQueue_Remove(kMsgQueue queue, void* item, k64u timeout);

#define kMsgQueue_RemoveT(kMsgQueue_queue, TPtr_item, k64u_timeout) \
     xkMsgQueue_RemoveT(kMsgQueue_queue, TPtr_item, k64u_timeout, sizeof(*(TPtr_item)))

kFx(kStatus) kMsgQueue_Clear(kMsgQueue queue);

kFx(kStatus) kMsgQueue_Purge(kMsgQueue queue);

kFx(kStatus) kMsgQueue_PurgeEx(kMsgQueue queue, kMsgQueuePurgeOption options);

kFx(kSize) kMsgQueue_Count(kMsgQueue queue);

kFx(kSize) kMsgQueue_MaxSize(kMsgQueue queue);

kFx(kSize) kMsgQueue_MaxCount(kMsgQueue queue);

kFx(kType) kMsgQueue_ItemType(kMsgQueue queue);

kFx(kSize) kMsgQueue_ItemSize(kQueue queue);

kFx(kSize) kMsgQueue_DataSize(kMsgQueue queue);

kFx(k64u) kMsgQueue_DropCount(kMsgQueue queue);

#endif