client/qos/EraseQos.h

Go to the documentation of this file.

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

#ifndef _CLIENT_QOS_ERASEQOS_H
#define _CLIENT_QOS_ERASEQOS_H

#include <util/xmlBlasterDef.h>
#include <client/qos/UnSubscribeQos.h>
#include <util/qos/HistoryQos.h>

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

class Dll_Export EraseQos : public org::xmlBlaster::client::qos::UnSubscribeQos
{
public:
   EraseQos(org::xmlBlaster::util::Global& global);

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

   EraseQos(const EraseQos& qos);

   EraseQos& operator =(const EraseQos& qos);

   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);
   }

   void setForceDestroy(bool forceDestroy);

   void setHistoryQos(org::xmlBlaster::util::qos::HistoryQos historyQos);

   /*
    * Mark the erase request to be persistent. 
    * <p>
    * NOTE: The request is only persistent in the client side
    * queue if we are polling for xmlBlaster.
    * </p>
   void setPersistent(bool persistent);
   */

   /*
    * NOT IMPLEMENTED
    * @param notify true - notify subscribers that message is erased (default is true)
   void setWantNotify(bool notify);
   */
};

}}}} // namespace

#endif