client/qos/SubscribeQos.h

Go to the documentation of this file.

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

#ifndef _CLIENT_QOS_SUBSCRIBEQOS_H
#define _CLIENT_QOS_SUBSCRIBEQOS_H

#include <util/xmlBlasterDef.h>
#include <client/qos/GetQos.h>
#include <util/SessionName.h>
#include <client/key/SubscribeKey.h>

namespace org { namespace xmlBlaster { namespace client { namespace qos {

class Dll_Export SubscribeQos : public GetQos
{
public:
   SubscribeQos(org::xmlBlaster::util::Global& global);

   SubscribeQos(org::xmlBlaster::util::Global& global, const org::xmlBlaster::util::qos::QueryQosData& data);

   SubscribeQos(const SubscribeQos& qos);

   SubscribeQos& operator =(const SubscribeQos& qos);

   void setWantInitialUpdate(bool initialUpdate);

   void setWantUpdateOneway(bool updateOneway);

   void setMultiSubscribe(bool multiSubscribe);
   
   bool getMultiSubscribe() const;

   void setWantLocal(bool local);

   void setWantNotify(bool notifyOnErase);

   void setSubscriptionId(const std::string& subscriptionId) const;

   std::string generateSubscriptionId(org::xmlBlaster::util::SessionNameRef sessionName, const org::xmlBlaster::client::key::SubscribeKey& subscribeKey);

   bool hasSubscriptionId() const;

   void setPersistent(bool persistent);

   template <typename T_VALUE> void addClientProperty(
            const std::string& name,
            const T_VALUE& value,
            const std::string& type="",
            const std::string& encoding="") {
      data_.addClientProperty(name, value, type, encoding);
   }

};

}}}} // namespace

#endif