client/qos/PublishQos.h

Go to the documentation of this file.

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

#ifndef _CLIENT_QOS_PUBLISHQOS_H
#define _CLIENT_QOS_PUBLISHQOS_H

#include <util/xmlBlasterDef.h>
#include <util/qos/storage/QueuePropertyBase.h>
#include <util/PriorityEnum.h>
#include <util/qos/MsgQosData.h>




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

class Dll_Export PublishQos
{
private:
   std::string     ME;
   org::xmlBlaster::util::Global&    global_;
   org::xmlBlaster::util::qos::MsgQosData msgQosData_;

public:
   PublishQos(org::xmlBlaster::util::Global& global);

   PublishQos(org::xmlBlaster::util::Global& global, const org::xmlBlaster::util::Destination& destination);

   PublishQos(org::xmlBlaster::util::Global& global, bool persistent);

   const org::xmlBlaster::util::qos::MsgQosData& getData();

   org::xmlBlaster::util::PriorityEnum getPriority() const;

   void setPriority(org::xmlBlaster::util::PriorityEnum priority);

   void setForceUpdate(bool force);

   void setForceDestroy(bool forceDestroy);

   void setSubscribable(bool isSubcribeable);

   void setReadonly(bool readonly);

   void setVolatile(bool volatileFlag);

   bool isVolatile();

   void setPersistent(bool persistent);

   void setLifeTime(long lifeTime);

   void addDestination(const org::xmlBlaster::util::Destination& destination);

   org::xmlBlaster::util::SessionNameRef getSender();

   /*
    * Access sender name.
    * @param loginName of sender
    * @deprecated The sender is forced to the correct client name automatically
    */
   //void setSender(const org::xmlBlaster::util::SessionName& sender);

   void setState(const std::string& state);

   std::string getState();

   void setStateInfo(const std::string& stateInfo);

   std::string getStateInfo();

   void setTopicProperty(const org::xmlBlaster::util::qos::TopicProperty& topicProperty);

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

   void setClientProperties(const org::xmlBlaster::util::qos::QosData::ClientPropertyMap& cm);

   const org::xmlBlaster::util::qos::QosData::ClientPropertyMap& getClientProperties() const;

   std::string toString();

   std::string toXml();
};

}}}}

#endif