util/qos/address/AddressBase.h

Go to the documentation of this file.

/*------------------------------------------------------------------------------
Name:      org::xmlBlaster::util::qos::address::AddressBase.h
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Comment:   Holding connect address and callback address std::string including protocol
Version:   $Id: AddressBase.h 14269 2005-12-06 12:25:08Z ruff $
------------------------------------------------------------------------------*/

#ifndef _UTIL_CFG_ADDRESSBASE_H
#define _UTIL_CFG_ADDRESSBASE_H

#include <util/xmlBlasterDef.h>
#include <util/Constants.h>
#include <util/I_Log.h>
#include <util/qos/ClientProperty.h>
#include <string>
#include <map>
#include <util/ReferenceCounterBase.h>
#include <util/ReferenceHolder.h>

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

extern Dll_Export const int       DEFAULT_port;
extern Dll_Export const std::string    DEFAULT_type;
extern Dll_Export const std::string    DEFAULT_version;
extern Dll_Export const long      DEFAULT_collectTime;
extern Dll_Export const int       DEFAULT_burstModeMaxEntries;
extern Dll_Export const long      DEFAULT_burstModeMaxBytes;
extern Dll_Export const bool      DEFAULT_oneway;
extern Dll_Export const bool      DEFAULT_dispatcherActive;
extern Dll_Export const std::string    DEFAULT_compressType;
extern Dll_Export const long      DEFAULT_minSize;
extern Dll_Export const bool      DEFAULT_ptpAllowed;
extern Dll_Export const std::string    DEFAULT_sessionId;
extern Dll_Export const bool      DEFAULT_useForSubjectQueue;
extern Dll_Export std::string    DEFAULT_dispatchPlugin;
extern Dll_Export std::string    ATTRIBUTE_TAG;



class Dll_Export AddressBase : public org::xmlBlaster::util::ReferenceCounterBase
{
   friend class AddressFactory;

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

private:
   int port_;

   void setRootTag(const std::string& rootTag)
   {
      rootTag_ = rootTag;
   }

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

   std::string rootTag_;

   std::string nodeId_;

   long maxEntries_; // only used in org::xmlBlaster::util::qos::address::Address

   mutable std::string address_;

   mutable std::string hostname_;
   bool isHardcodedHostname_; // = false; // set to true if setHostname() was explicitly called by user

   std::string type_; //  = DEFAULT_type;
   
   std::string version_; // = DEFAULT_version;
   
   long collectTime_; //  = DEFAULT_collectTime;

   int burstModeMaxEntries_; //  = 1

   long burstModeMaxBytes_; //  = -1L
   
   long pingInterval_; //  = getDefaultPingInterval();
   
   int retries_; //  = getDefaultRetries();
   
   long delay_; //  = getDefaultDelay();

   bool oneway_; // = DEFAULT_oneway;
   
   bool dispatcherActive_; // = DEFAULT_dispatcherActive;

   std::string compressType_; // = DEFAULT_compressType;
   
   long minSize_; // = DEFAULT_minSize;
   
   bool ptpAllowed_; // = DEFAULT_ptpAllowed;
   
   std::string sessionId_; // = DEFAULT_sessionId;

   bool useForSubjectQueue_; // = DEFAULT_useForSubjectQueue;

   std::string dispatchPlugin_; // = DEFAULT_dispatchPlugin;

   ClientPropertyMap attributes_; 

   void initHostname(const std::string& hostname)
   {
      hostname_ = hostname;
      address_  = ""; // reset cache
   }

   void copy(const AddressBase& addr);

   long defaultPingInterval_;
   int defaultRetries_;
   long defaultDelay_;

public:

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

   AddressBase(const AddressBase& addr);

   AddressBase& operator =(const AddressBase& addr);

   virtual ~AddressBase();

   std::string getName();

   bool isSameAddress(AddressBase& other);

   std::string getSettings() const;

   void addAttribute(const ClientProperty& attribute);

   const ClientPropertyMap& getAttributes() const;

   std::string dumpAttributes(const std::string& extraOffset, bool clearText=false) const;

   void setType(const std::string& type);

   void setVersion(const std::string& version);

   void setHostname(const std::string& host);

   bool isHardcodedHostname();

   bool hasHostname();

   std::string getHostname() const;

   void setPort(int port);

   int getPort() const;

   void setAddress(const std::string& address);

   std::string getRawAddress() const;

   std::string getType() const;

   std::string getVersion() const;

   std::string getOnExhaust() const;

   bool getOnExhaustKillSession() const;

   long getCollectTime() const;

   void setCollectTime(long collectTime);

   int getBurstModeMaxEntries() const;

   void setBurstModeMaxEntries(int burstModeMaxEntries);

   long getBurstModeMaxBytes() const;

   void setBurstModeMaxBytes(long BurstModeMaxBytes);

   long getPingInterval() const;

   void setPingInterval(long pingInterval);

   int getRetries() const;

   void setRetries(int retries);

   long getDelay() const;

   void setDelay(long delay);

   bool oneway() const;

   void setOneway(bool oneway);

   void setDispatcherActive(bool dispatcherActive);
   
   bool isDispatcherActive() const;

   void setPtpAllowed(bool ptpAllowed);

   bool isPtpAllowed();

   void setCompressType(const std::string& compressType);

   std::string getSecretSessionId() const;

   void setSecretSessionId(const std::string& sessionId);

   std::string getCompressType() const;

   long getMinSize() const;

   void setMinSize(long minSize);

   void setDispatchPlugin(const std::string& dispatchPlugin);

   std::string getDispatchPlugin() const;

   const ClientPropertyMap& getClientProperties() const;

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

typedef org::xmlBlaster::util::ReferenceHolder<AddressBase> AddressBaseRef;

}}}}}

#endif