util/queue/CacheQueuePlugin.h

Go to the documentation of this file.

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

#include <util/xmlBlasterDef.h>
#include <util/ReferenceHolder.h>
#include <util/queue/I_Queue.h>
#include <util/queue/MsgQueueEntry.h>
#include <util/thread/ThreadImpl.h>
#include <util/I_Log.h>
#include <set>

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

typedef std::set<EntryType, std::greater<EntryType> > StorageType;

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

   long reloadFromPersistentStore() const;

protected:
   std::string ME;
   org::xmlBlaster::util::Global& global_;
   org::xmlBlaster::util::I_Log& log_;
   org::xmlBlaster::util::qos::storage::ClientQueueProperty property_;
   mutable I_Queue *transientQueueP_;
   I_Queue *persistentQueueP_;
   org::xmlBlaster::util::thread::Mutex accessMutex_;

public:
   CacheQueuePlugin(org::xmlBlaster::util::Global& global, const org::xmlBlaster::util::qos::storage::ClientQueueProperty& property);

   virtual ~CacheQueuePlugin();
    
   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;

    static std::string usage();

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

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

   void destroy();
};

}}}} // namespace

#endif