util/queue/QueueInterface.h

Go to the documentation of this file.

/*----------------------------------------------------------------------------
Name:      QueueInterface.h
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Author:    "Marcel Ruff" <xmlBlaster@marcelruff.info>
Comment:   Interface for transient or persistent queue implementations
           with priority and time stamp sorting
Note:      The gcc and icc (>=8) both define __GNUC__
See:       http://www.xmlblaster.org/xmlBlaster/doc/requirements/client.c.queue.html
See:       http://www.xmlblaster.org/xmlBlaster/doc/requirements/queue.html
-----------------------------------------------------------------------------*/
#ifndef I_QUEUE_QueueInterface_h
#define I_QUEUE_QueueInterface_h

#include "util/helper.h" /* BlobHolder. basicDefs.h: for int64_t (C99), Dll_Export, bool etc. */

#ifdef __cplusplus
#ifndef XMLBLASTER_C_COMPILE_AS_CPP /* 'g++ -DXMLBLASTER_C_COMPILE_AS_CPP ...' allows to compile the lib as C++ code */
extern "C" {
#endif
#endif

/*const int QUEUE_ENTRY_EMBEDDEDTYPE_LEN = 28; -> not supported with C90 to be used for array sizes */
#define QUEUE_ENTRY_EMBEDDEDTYPE_LEN 28

#define QUEUE_PREFIX_MAX 20
#define QUEUE_DBNAME_MAX 256
#define QUEUE_ID_MAX 256

typedef struct {
   char dbName[QUEUE_DBNAME_MAX];      
   char queueName[QUEUE_ID_MAX];       
   char tablePrefix[QUEUE_PREFIX_MAX]; 
   int32_t maxNumOfEntries;            
   int64_t maxNumOfBytes;              
   XmlBlasterLogging logFp;            
   XMLBLASTER_LOG_LEVEL logLevel;      
   void *userObject;                   
} QueueProperties;

typedef struct {
   int64_t uniqueId;        
   int16_t priority;        
   bool isPersistent;       
   int64_t sizeInBytes;     
   char embeddedType[QUEUE_ENTRY_EMBEDDEDTYPE_LEN]; 
   BlobHolder embeddedBlob; 
} QueueEntry;

typedef struct QueueEntryStructArr {
   size_t len;
   QueueEntry *queueEntryArr;
} QueueEntryArr;

struct I_QueueStruct;
typedef struct I_QueueStruct I_Queue;

typedef bool  ( * I_QueueInitialize)(I_Queue *queueP, const QueueProperties *queueProperties, ExceptionStruct *exception);
typedef void  ( * I_QueueShutdown)(I_Queue **queuePP, ExceptionStruct *exception);
typedef bool  ( * I_QueueDestroy)(I_Queue **queuePP, ExceptionStruct *exception);
typedef const QueueProperties *( * I_QueueGetProperties)(I_Queue *queueP);
typedef void  ( * I_QueuePut)(I_Queue *queueP, const QueueEntry *queueEntry, ExceptionStruct *exception);
typedef QueueEntryArr *( * I_QueuePeekWithSamePriority)(I_Queue *queueP, int32_t maxNumOfEntries, int64_t maxNumOfBytes, ExceptionStruct *exception);
typedef int32_t ( * I_QueueRandomRemove)(I_Queue *queueP, const QueueEntryArr *queueEntryArr, ExceptionStruct *exception);
typedef bool  ( * I_QueueClear)(I_Queue *queueP, ExceptionStruct *exception);
typedef bool  ( * I_QueueEmpty)(I_Queue *queueP);
typedef int32_t ( * I_QueueNumOfEntries)(I_Queue *queueP);
typedef int32_t ( * I_QueueMaxNumOfEntries)(I_Queue *queueP);
typedef int64_t ( * I_QueueNumOfBytes)(I_Queue *queueP);
typedef int64_t ( * I_QueueMaxNumOfBytes)(I_Queue *queueP);

struct I_QueueStruct {
  /* public: */
   void *userObject; /* A client can use this pointer to point to any client specific information */

   I_QueueGetProperties getProperties;

   I_QueuePut put;

   I_QueuePeekWithSamePriority peekWithSamePriority;

   I_QueueRandomRemove randomRemove;

   I_QueueClear clear;

   I_QueueShutdown shutdown;

   I_QueueDestroy destroy;

   I_QueueNumOfEntries getNumOfEntries;

   I_QueueMaxNumOfEntries getMaxNumOfEntries;

   I_QueueNumOfBytes getNumOfBytes;

   I_QueueMaxNumOfBytes getMaxNumOfBytes;

   I_QueueEmpty empty;

   XMLBLASTER_LOG_LEVEL logLevel;

   XmlBlasterLogging log;

  /* private: */

   I_QueueInitialize initialize;
   bool isInitialized;  
   void *privateObject; 
};

Dll_Export extern I_Queue *createQueue(const QueueProperties *queueProperties, ExceptionStruct *exception);

extern Dll_Export void freeQueueEntryArr(QueueEntryArr *queueEntryArr);

extern Dll_Export void freeQueueEntryArrInternal(QueueEntryArr *queueEntryArr);

extern Dll_Export void freeQueueEntry(QueueEntry *queueEntry);

extern Dll_Export char *queueEntryToXml(QueueEntry *queueEntry, int maxContentDumpLen);

extern Dll_Export void freeEntryDump(char *queueDump);

#ifdef __cplusplus
#ifndef XMLBLASTER_C_COMPILE_AS_CPP
}
#endif
#endif

#endif /* I_QUEUE_QueueInterface_h */