util/qos/QosData.h

Go to the documentation of this file.

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

#ifndef _UTIL_QOS_QOSDATA_H
#define _UTIL_QOS_QOSDATA_H

#include <util/xmlBlasterDef.h>
#include <util/cluster/RouteInfo.h>
#include <util/SessionName.h>
#include <util/qos/ClientProperty.h>
#include <util/PriorityEnum.h>
#include <util/ReferenceCounterBase.h>
#include <util/ReferenceHolder.h>
#include <vector>
#include <map>
#include <string>

namespace org { namespace xmlBlaster { namespace util { namespace qos {

extern Dll_Export const bool DEFAULT_isSubscribable;
extern Dll_Export const bool DEFAULT_isVolatile;
extern Dll_Export const bool DEFAULT_persistent;
extern Dll_Export const bool DEFAULT_forceUpdate;
extern Dll_Export const bool DEFAULT_forceDestroy;

// extern Dll_Export const bool DEFAULT_readonly;

typedef std::vector<org::xmlBlaster::util::cluster::RouteInfo> RouteVector;

class Dll_Export QosData : public org::xmlBlaster::util::ReferenceCounterBase
{

private:
   void init();

protected:
   std::string  ME;
   org::xmlBlaster::util::Global& global_;
   org::xmlBlaster::util::I_Log&    log_;
   std::string  serialData_;

   std::string state_; // = Constants::STATE_OK;
   std::string stateInfo_;

   Timestamp rcvTimestamp_;
   bool rcvTimestampFound_; // = false;

   org::xmlBlaster::util::PriorityEnum priority_; // = org::xmlBlaster::util::PriorityEnum.NORM_PRIORITY;

   bool fromPersistenceStore_; // = false;

   bool persistent_; // = DEFAULT_persistent;

   RouteVector routeNodeList_;

public:   typedef std::map<std::string, org::xmlBlaster::util::qos::ClientProperty> ClientPropertyMap;
protected:

   ClientPropertyMap clientProperties_; 

   mutable org::xmlBlaster::util::SessionNameRef sender_;

   void copy(const QosData& data);

   std::string dumpClientProperties(const std::string& extraOffset, bool clearText) const;

public:
//   long size_;

   QosData(org::xmlBlaster::util::Global& global, const std::string& serialData="");

   QosData(const QosData& data);

   QosData& operator=(const QosData& data);

   virtual ~QosData();

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

   std::string getState() const;

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

   std::string getStateInfo() const;

   bool isOk() const;

   bool isErased() const;

   bool isTimeout() const;

   bool isForwardError() const;

   void addRouteInfo(const org::xmlBlaster::util::cluster::RouteInfo& routeInfo);

   int count(const org::xmlBlaster::util::cluster::NodeId& nodeId) const;

   bool dirtyRead(org::xmlBlaster::util::cluster::NodeId nodeId) const;

   void setRcvTimestamp(Timestamp rcvTimestamp);

   Timestamp getRcvTimestamp() const;

   void touchRcvTimestamp();

   void addClientProperty(const ClientProperty& clientProperty);

   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="");

   template <typename T_VALUE> T_VALUE getClientProperty(
            const std::string& name,
            const T_VALUE& defaultValue);
        
   bool hasClientProperty(const std::string& name) const;
   const ClientPropertyMap& getClientProperties() const;
   void setClientProperties(const ClientPropertyMap& cm);

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

   void setSender(org::xmlBlaster::util::SessionNameRef sender) const;

   virtual std::string toXml(const std::string& extraOffset="") const;

   virtual QosData* getClone() const;

    // the following where not present before ...
   RouteVector getRouteNodes() const;

   void clearRoutes();

   int size() const;

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

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

   bool isFromPersistenceStore() const;

   void setFromPersistenceStore(bool fromPersistenceStore);

   void setPersistent(bool persistent);

   bool isPersistent() const;
};

typedef org::xmlBlaster::util::ReferenceHolder<org::xmlBlaster::util::qos::QosData> QosDataRef;

template <typename T_VALUE> void QosData::addClientProperty(
             const std::string& name, const T_VALUE& value,
             const std::string& type, const std::string& encoding,
             const std::string& charset)
{
   org::xmlBlaster::util::qos::ClientProperty clientProperty(name, value, type, encoding, charset);
   clientProperties_.insert(ClientPropertyMap::value_type(name, clientProperty));   
}

template <typename T_VALUE> T_VALUE QosData::getClientProperty(
             const std::string& name, const T_VALUE& defaultValue)
{
   ClientPropertyMap::const_iterator iter = clientProperties_.find(name);
   if (iter != clientProperties_.end()) {
      T_VALUE tmp;
      (*iter).second.getValue(tmp);
      return tmp;
   }
   return defaultValue;
}
        
}}}}

#endif