QueueProperties Struct Reference

The QueueProperty struct holds all configuration parameters of the queue to create. More...

#include <QueueInterface.h>


Data Fields

char dbName [256]
 The database name, for SQLite it is the file name on HD, "xmlBlaster.db".
char queueName [256]
 The name of the queue, "connection_client_joe".
char tablePrefix [20]
 The table prefix to use, "XB_".
int32_t maxNumOfEntries
 The max.
int64_t maxNumOfBytes
 The max.
XmlBlasterLogging logFp
 Your logging implementation or NULL if no logging callbacks are desired.
XMLBLASTER_LOG_LEVEL logLevel
 Set to LOG_TRACE to receive any logging.
void * userObject
 A pointer of your choice, is passed back when calling logFp in queueP->userObject.

Detailed Description

The QueueProperty struct holds all configuration parameters of the queue to create.

It is passed by the client code to create a queue.

Definition at line 33 of file QueueInterface.h.

Field Documentation

char QueueProperties::dbName[256]

The database name, for SQLite it is the file name on HD, "xmlBlaster.db".

Definition at line 34 of file QueueInterface.h.

Referenced by destroy(), persistentQueueDestroy(), persistentQueueInitialize(), test_illegal(), test_overflow(), test_queue(), and xmlBlasterInitQueue().

char QueueProperties::queueName[256]

The name of the queue, "connection_client_joe".

Definition at line 35 of file QueueInterface.h.

Referenced by destroy(), fillCache(), persistentQueueInitialize(), persistentQueuePeekWithSamePriority(), persistentQueuePut(), persistentQueueRandomRemove(), test_illegal(), test_overflow(), test_queue(), and xmlBlasterInitQueue().

char QueueProperties::tablePrefix[20]

The table prefix to use, "XB_".

Definition at line 36 of file QueueInterface.h.

Referenced by destroy(), fillCache(), persistentQueueClear(), persistentQueueInitialize(), persistentQueuePeekWithSamePriority(), persistentQueuePut(), persistentQueueRandomRemove(), test_illegal(), test_overflow(), test_queue(), and xmlBlasterInitQueue().

int32_t QueueProperties::maxNumOfEntries

The max.

accepted entries, 10000

Definition at line 37 of file QueueInterface.h.

Referenced by destroy(), getMaxNumOfEntries(), persistentQueueInitialize(), persistentQueuePut(), test_illegal(), test_overflow(), test_queue(), and xmlBlasterInitQueue().

int64_t QueueProperties::maxNumOfBytes

The max.

capacity of the queue in bytes, 10000000LL

Definition at line 38 of file QueueInterface.h.

Referenced by destroy(), getMaxNumOfBytes(), persistentQueueInitialize(), persistentQueuePut(), test_illegal(), test_overflow(), test_queue(), and xmlBlasterInitQueue().

XmlBlasterLogging QueueProperties::logFp

Your logging implementation or NULL if no logging callbacks are desired.

Definition at line 39 of file QueueInterface.h.

Referenced by persistentQueueInitialize(), test_overflow(), test_queue(), and xmlBlasterInitQueue().

XMLBLASTER_LOG_LEVEL QueueProperties::logLevel

Set to LOG_TRACE to receive any logging.

Definition at line 40 of file QueueInterface.h.

Referenced by persistentQueueInitialize(), test_overflow(), test_queue(), and xmlBlasterInitQueue().

void* QueueProperties::userObject

A pointer of your choice, is passed back when calling logFp in queueP->userObject.

Definition at line 41 of file QueueInterface.h.

Referenced by persistentQueueInitialize(), test_overflow(), test_queue(), and xmlBlasterInitQueue().

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