util/queue/I_Queue.h

Go to the documentation of this file.

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

#include <util/xmlBlasterDef.h>
#include <util/ReferenceHolder.h>
#include <util/queue/MsgQueueEntry.h>
#include <util/plugin/I_Plugin.h>

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

typedef ReferenceHolder<MsgQueueEntry> EntryType;

class Dll_Export I_Queue : public virtual org::xmlBlaster::util::plugin::I_Plugin
{
public:
   virtual ~I_Queue() {};
    
   virtual void put(const MsgQueueEntry &entry) = 0;

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

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

   virtual long getNumOfEntries() const = 0;

   virtual long getMaxNumOfEntries() const = 0;

   virtual int64_t getNumOfBytes() const = 0;

   virtual int64_t getMaxNumOfBytes() const = 0;

   virtual void clear() = 0;

   virtual bool empty() const = 0;

   virtual void destroy() = 0;
};

}}}} // namespace

#endif