subscribequeueentry.h

java开源的企业总线.xmlBlaster

/*------------------------------------------------------------------------------
Name:      SubscribeQueueEntry.h
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
------------------------------------------------------------------------------*/

#ifndef _UTIL_QUEUE_SUBSCRIBEQUEUEENRY_H
#define _UTIL_QUEUE_SUBSCRIBEQUEUEENRY_H

#include <util/MethodName.h>
#include <util/queue/MsgQueueEntry.h>
#include <client/qos/SubscribeQos.h>
#include <client/qos/SubscribeReturnQos.h>
#include <client/key/SubscribeKey.h>


/**
 * Class embedding messages or information to be stored on the client queues
 * Note that all content is copied when passed to the constructors.
 * This way this queue entry is the owner of the content (and therefore will
 * delete it when its destructor is called).
 *
 * @author <a href='mailto:[e-mail]'>Michele Laghi</a>
 */
namespace org { namespace xmlBlaster { namespace util { namespace queue {

class Dll_Export SubscribeQueueEntry : public org::xmlBlaster::util::queue::MsgQueueEntry
{
public:

   /**
    * Constructor suited for operations like subscribe and unSubscribe
    */
   SubscribeQueueEntry(org::xmlBlaster::util::Global& global,
                       const org::xmlBlaster::client::key::SubscribeKey& subscribeKey,
                       const org::xmlBlaster::client::qos::SubscribeQos& subscribeQos,
                       int priority=NORM_PRIORITY,
                       org::xmlBlaster::util::Timestamp uniqueId = TimestampFactory::getInstance().getTimestamp());

   ~SubscribeQueueEntry();

   /**
    * copy constructor
    */
   SubscribeQueueEntry(const SubscribeQueueEntry& entry);

   /**
    * assignment constructor
    */
   SubscribeQueueEntry& operator =(const SubscribeQueueEntry& entry);

   MsgQueueEntry *getClone() const;

   virtual bool isSubscribe() const;

   // this should actually be in another interface but since it is an only method we put it here.
   const org::xmlBlaster::util::queue::MsgQueueEntry& send(org::xmlBlaster::util::dispatch::I_ConnectionsHandler& connectionsHandler) const;

   /**
    * @return A copy of the subscribe QoS
    */
   org::xmlBlaster::client::qos::SubscribeQos getSubscribeQos() const;

   /**
    * @return A copy of the subscribe Key
    */
   org::xmlBlaster::client::key::SubscribeKey getSubscribeKey() const;
 
   org::xmlBlaster::client::qos::SubscribeReturnQos getSubscribeReturnQos() const;

   std::string toXml(const std::string& indent="") const;

};

}}}} // namespace

#endif