util/queue/SQLiteQueuePlugin.h

Go to the documentation of this file.

/*------------------------------------------------------------------------------
Name:      SQLiteQueuePlugin.h
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
------------------------------------------------------------------------------*/
#ifndef _UTIL_QUEUE_SQLITEQUEUE_H
#define _UTIL_QUEUE_SQLITEQUEUE_H

#include <util/xmlBlasterDef.h>
#include <util/ReferenceHolder.h>
#include <util/queue/I_Queue.h>
#include <util/queue/MsgQueueEntry.h>
#include <util/qos/ConnectQosFactory.h>
#include <util/qos/StatusQosFactory.h>
#include <util/qos/MsgQosFactory.h>
#include <util/key/MsgKeyFactory.h>
#include <util/thread/ThreadImpl.h>
#include <util/I_Log.h>

struct I_QueueStruct;
struct ExceptionStruct;

namespace org { namespace xmlBlaster { namespace util { namespace queue {

class Dll_Export SQLiteQueuePlugin : public I_Queue
{
private:
   SQLiteQueuePlugin(const SQLiteQueuePlugin& queue);
   SQLiteQueuePlugin& operator =(const SQLiteQueuePlugin& queue);

protected:
   std::string ME;
   org::xmlBlaster::util::Global& global_;
   org::xmlBlaster::util::I_Log& log_;
   org::xmlBlaster::util::qos::storage::QueuePropertyBase property_;
   struct ::I_QueueStruct *queueP_; // The C based xmlBlaster SQLite queue implementation
   mutable org::xmlBlaster::util::qos::ConnectQosFactory connectQosFactory_;
   mutable org::xmlBlaster::util::qos::StatusQosFactory statusQosFactory_;
   mutable org::xmlBlaster::util::key::MsgKeyFactory msgKeyFactory_;
   mutable org::xmlBlaster::util::qos::MsgQosFactory msgQosFactory_;
   org::xmlBlaster::util::thread::Mutex accessMutex_;

public:
   SQLiteQueuePlugin(org::xmlBlaster::util::Global& global, const org::xmlBlaster::util::qos::storage::ClientQueueProperty& property);
   
   virtual ~SQLiteQueuePlugin();
    
   org::xmlBlaster::util::I_Log& getLog() const { return log_; }

   void put(const MsgQueueEntry &entry);

   const std::vector<EntryType> peekWithSamePriority(long maxNumOfEntries=-1, long maxNumOfBytes=-1) const;

   long randomRemove(const std::vector<EntryType>::const_iterator &start, const std::vector<EntryType>::const_iterator &end);

   long getNumOfEntries() const;

   long getMaxNumOfEntries() const;

   int64_t getNumOfBytes() const;

   int64_t getMaxNumOfBytes() const;

   void clear();

   bool empty() const;

   org::xmlBlaster::util::XmlBlasterException convertFromQueueException(const ::ExceptionStruct *ex) const;

   static void parseEmbeddedType(const std::string& embeddedType, std::string &type, std::string &methodName);

   static std::string usage();

   std::string getType() { static std::string type = "SQLite"; return type; }

   std::string getVersion() { static std::string version = "1.0"; return version; }

   void destroy();
};

}}}} // namespace

#endif