org::xmlBlaster::util::qos::address::AddressBase Class Reference

Inheritance diagram for org::xmlBlaster::util::qos::address::AddressBase:

Inheritance graph
[legend]
Collaboration diagram for org::xmlBlaster::util::qos::address::AddressBase:

Collaboration graph
[legend]
List of all members.

Public Types

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

Public Member Functions

 AddressBase (org::xmlBlaster::util::Global &global, std::string &rootTag="")
 common constructor
 AddressBase (AddressBase &addr)
 copy constructor
AddressBaseoperator= (AddressBase &addr)
 Assignment operator.
virtual ~AddressBase ()
std::string getName ()
 A nice human readable name for this address (used for logging).
bool isSameAddress (AddressBase &other)
 Check if supplied address would connect to the address of this instance.
std::string getSettings ()
 Show some important settings for logging.
void addAttribute (ClientProperty &attribute)
ClientPropertyMapgetAttributes ()
std::string dumpAttributes (std::string &extraOffset, bool clearText=false)
 The address and callbackAddress may contain additional attributes which are passed to the protocol plugin.
void setType (std::string &type)
 
Parameters:
type The protocol type, e.g.

void setVersion (std::string &version)
 
Parameters:
version The protocol version, e.g.

void setHostname (std::string &host)
 Updates the internal address as well.
bool isHardcodedHostname ()
 
Returns:
true if the bootstrapHostname is explicitly set by user with setHostname() false if it is determined automatically

bool hasHostname ()
 Check if a bootstrapHostname is set already.
std::string getHostname ()
 
Returns:
The Hostname, IP or "" if not known

void setPort (int port)
 Set the bootstrapping port.
int getPort ()
void setAddress (std::string &address)
 Set the callback address, it should fit to the protocol-type.
std::string getRawAddress ()
 Returns the address.
std::string getType ()
 Returns the protocol type.
std::string getVersion ()
 Returns the protocol version.
std::string getOnExhaust ()
 What to do if max retries is exhausted.
bool getOnExhaustKillSession ()
 Kill login session if max callback retries is exhausted?
long getCollectTime ()
 BurstMode: The time span to collect messages before sending.
void setCollectTime (long collectTime)
 BurstMode: The time to collect messages for sending in a bulk.
int getBurstModeMaxEntries ()
 How many messages maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.
void setBurstModeMaxEntries (int burstModeMaxEntries)
 How many messages maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.
long getBurstModeMaxBytes ()
 How many bytes maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.
void setBurstModeMaxBytes (long BurstModeMaxBytes)
 How many bytes maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.
long getPingInterval ()
 How long to wait between pings to the callback server.
void setPingInterval (long pingInterval)
 How long to wait between pings to the callback server.
int getRetries ()
 How often shall we retry callback attempt on callback failure.
void setRetries (int retries)
 How often shall we retry callback attempt on callback failure.
long getDelay ()
 Delay between callback retries in milliseconds, defaults to one minute.
void setDelay (long delay)
 Delay between callback retries in milliseconds, defaults to one minute.
bool oneway ()
 Shall the publish() or callback update() message be oneway.
void setOneway (bool oneway)
 Shall the publish() or callback update() message be oneway.
void setDispatcherActive (bool dispatcherActive)
 Inhibits/activates the delivery of asynchronous dispatches of messages.
bool isDispatcherActive ()
 
Returns:
true if the dispatcher is currently activated, i.e.

void setPtpAllowed (bool ptpAllowed)
 
Parameters:
Set if we accept point to point messages

bool isPtpAllowed ()
 
Returns:
true if we may send PtP messages

void setCompressType (std::string &compressType)
std::string getSecretSessionId ()
 The identifier sent to the callback client, the client can decide if he trusts this invocation.
void setSecretSessionId (std::string &sessionId)
 The identifier sent to the callback client, the client can decide if he trusts this invocation.
std::string getCompressType ()
 Get the compression method.
long getMinSize ()
 Messages bigger this size in bytes are compressed.
void setMinSize (long minSize)
 Messages bigger this size in bytes are compressed.
void setDispatchPlugin (std::string &dispatchPlugin)
 Specify your dispatcher plugin configuration.
std::string getDispatchPlugin ()
 
Returns:
"undef" or e.g.

ClientPropertyMapgetClientProperties ()
std::string toXml (std::string &extraOffset="")
 Dump state of this object into a XML ASCII std::string.

Protected Member Functions

void initHostname (std::string &hostname)
void copy (AddressBase &addr)

Protected Attributes

std::string ME
org::xmlBlaster::util::Globalglobal_
org::xmlBlaster::util::I_Loglog_
std::string rootTag_
std::string nodeId_
 The node id to which we want to connect.
long maxEntries_
 TODO: Move this attribute to CbQueueProperty.java.
std::string address_
 The unique address, e.g.
std::string hostname_
bool isHardcodedHostname_
std::string type_
 The unique protocol type, e.g.
std::string version_
 The protocol version, e.g.
long collectTime_
 BurstMode: The time to collect messages for publish/update.
int burstModeMaxEntries_
 How many messages maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.
long burstModeMaxBytes_
 How many bytes maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.
long pingInterval_
 Ping interval: pinging every given milliseconds.
int retries_
 How often to retry if connection fails.
long delay_
 Delay between connection retries in milliseconds.
bool oneway_
 Shall the update() or publish() messages be send oneway (no application level ACK).
bool dispatcherActive_
 Control if the dispatcher is activated on login, i.e.
std::string compressType_
 Compress messages if set to "gzip" or "zip".
long minSize_
 Messages bigger this size in bytes are compressed.
bool ptpAllowed_
 PtP messages wanted? Defaults to true, false prevents spamming.
std::string sessionId_
 The identifier sent to the callback client, the client can decide if he trusts this invocation.
bool useForSubjectQueue_
 Shall this session callback be used for subjectQueue messages as well? For <callback> only.
std::string dispatchPlugin_
 Does client whish a dispatcher plugin.
ClientPropertyMap attributes_
long defaultPingInterval_
int defaultRetries_
long defaultDelay_

Friends

class AddressFactory

Detailed Description

Definition at line 50 of file AddressBase.h.


Member Typedef Documentation

typedef std::map<std::string, org::xmlBlaster::util::qos::ClientProperty> org::xmlBlaster::util::qos::address::AddressBase::ClientPropertyMap

Definition at line 54 of file AddressBase.h.


Constructor & Destructor Documentation

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

common constructor

org::xmlBlaster::util::qos::address::AddressBase::AddressBase ( AddressBase addr  ) 

copy constructor

Definition at line 80 of file AddressBase.cpp.

References copy().

org::xmlBlaster::util::qos::address::AddressBase::~AddressBase (  )  [virtual]

Definition at line 94 of file AddressBase.cpp.


Member Function Documentation

void org::xmlBlaster::util::qos::address::AddressBase::initHostname ( std::string &  hostname  )  [protected]

Definition at line 161 of file AddressBase.h.

void org::xmlBlaster::util::qos::address::AddressBase::copy ( AddressBase addr  )  [protected]

Definition at line 98 of file AddressBase.cpp.

References address_, attributes_, collectTime_, compressType_, defaultDelay_, defaultPingInterval_, defaultRetries_, delay_, dispatcherActive_, dispatchPlugin_, hostname_, isHardcodedHostname_, maxEntries_, ME, minSize_, nodeId_, oneway_, pingInterval_, port_, ptpAllowed_, retries_, rootTag_, sessionId_, type_, useForSubjectQueue_, and version_.

Referenced by AddressBase(), org::xmlBlaster::util::qos::address::CallbackAddress::operator=(), operator=(), and org::xmlBlaster::util::qos::address::Address::operator=().

AddressBase & org::xmlBlaster::util::qos::address::AddressBase::operator= ( AddressBase addr  ) 

Assignment operator.

Reimplemented in org::xmlBlaster::util::qos::address::Address, and org::xmlBlaster::util::qos::address::CallbackAddress.

Definition at line 87 of file AddressBase.cpp.

References copy().

string org::xmlBlaster::util::qos::address::AddressBase::getName (  ) 

A nice human readable name for this address (used for logging).

Definition at line 131 of file AddressBase.cpp.

References getHostname(), getPort(), and org::xmlBlaster::util::lexical_cast().

bool org::xmlBlaster::util::qos::address::AddressBase::isSameAddress ( AddressBase other  ) 

Check if supplied address would connect to the address of this instance.

Definition at line 139 of file AddressBase.cpp.

References getHostname(), getPort(), and getRawAddress().

string org::xmlBlaster::util::qos::address::AddressBase::getSettings (  ) 

Show some important settings for logging.

Reimplemented in org::xmlBlaster::util::qos::address::Address.

Definition at line 153 of file AddressBase.cpp.

References getCollectTime(), org::xmlBlaster::util::lexical_cast(), oneway_, and type_.

Referenced by org::xmlBlaster::util::qos::address::Address::getSettings().

void org::xmlBlaster::util::qos::address::AddressBase::addAttribute ( ClientProperty attribute  ) 

Definition at line 526 of file AddressBase.cpp.

References attributes_, and org::xmlBlaster::util::qos::ClientProperty::getName().

AddressBase::ClientPropertyMap & org::xmlBlaster::util::qos::address::AddressBase::getAttributes (  ) 

Definition at line 531 of file AddressBase.cpp.

References attributes_.

std::string org::xmlBlaster::util::qos::address::AddressBase::dumpAttributes ( std::string &  extraOffset,
bool  clearText = false 
)

The address and callbackAddress may contain additional attributes which are passed to the protocol plugin.

void org::xmlBlaster::util::qos::address::AddressBase::setType ( std::string &  type  ) 

Parameters:
type The protocol type, e.g.

"IOR", "SOCKET", "XMLRPC"

void org::xmlBlaster::util::qos::address::AddressBase::setVersion ( std::string &  version  ) 

Parameters:
version The protocol version, e.g.

"1.0"

void org::xmlBlaster::util::qos::address::AddressBase::setHostname ( std::string &  host  ) 

Updates the internal address as well.

Parameters:
host An IP or DNS

bool org::xmlBlaster::util::qos::address::AddressBase::isHardcodedHostname (  ) 

Returns:
true if the bootstrapHostname is explicitly set by user with setHostname() false if it is determined automatically

Definition at line 189 of file AddressBase.cpp.

References isHardcodedHostname_.

bool org::xmlBlaster::util::qos::address::AddressBase::hasHostname (  ) 

Check if a bootstrapHostname is set already.

Definition at line 197 of file AddressBase.cpp.

References hostname_.

string org::xmlBlaster::util::qos::address::AddressBase::getHostname (  ) 

Returns:
The Hostname, IP or "" if not known

Definition at line 204 of file AddressBase.cpp.

References address_, org::xmlBlaster::util::Global::getBootstrapHostname(), global_, and hostname_.

Referenced by getName(), getRawAddress(), and isSameAddress().

void org::xmlBlaster::util::qos::address::AddressBase::setPort ( int  port  ) 

Set the bootstrapping port.

Updates the internal address as well.

Definition at line 217 of file AddressBase.cpp.

References address_.

int org::xmlBlaster::util::qos::address::AddressBase::getPort (  ) 

Definition at line 223 of file AddressBase.cpp.

Referenced by getName(), getRawAddress(), and isSameAddress().

void org::xmlBlaster::util::qos::address::AddressBase::setAddress ( std::string &  address  ) 

Set the callback address, it should fit to the protocol-type.

Parameters:
address The callback address, e.g. "et@mars.univers"

string org::xmlBlaster::util::qos::address::AddressBase::getRawAddress (  ) 

Returns the address.

Returns:
e.g. "IOR:00001100022...." or "et@universe.com" or "socket://192.168.1.1:7607" or ""

Definition at line 239 of file AddressBase.cpp.

References address_, getHostname(), getPort(), getType(), org::xmlBlaster::util::lexical_cast(), and org::xmlBlaster::util::Constants::SOCKET.

Referenced by isSameAddress(), org::xmlBlaster::util::qos::address::CallbackAddress::toString(), and org::xmlBlaster::util::qos::address::Address::toString().

string org::xmlBlaster::util::qos::address::AddressBase::getType (  ) 

Returns the protocol type.

Returns:
e.g. "SOCKET" or "IOR" (never null).

Definition at line 254 of file AddressBase.cpp.

References type_.

Referenced by getRawAddress().

string org::xmlBlaster::util::qos::address::AddressBase::getVersion (  ) 

Returns the protocol version.

Returns:
e.g. "1.0" or null

Definition at line 263 of file AddressBase.cpp.

References version_.

string org::xmlBlaster::util::qos::address::AddressBase::getOnExhaust (  ) 

What to do if max retries is exhausted.

This mode is currently not configurable, we always destroy the login session. This is interpreted only server side if callback fails.

Returns:
Constants.ONEXHAUST_KILL_SESSION="killSession"

Definition at line 275 of file AddressBase.cpp.

References org::xmlBlaster::util::Constants::ONEXHAUST_KILL_SESSION.

Referenced by getOnExhaustKillSession().

bool org::xmlBlaster::util::qos::address::AddressBase::getOnExhaustKillSession (  ) 

Kill login session if max callback retries is exhausted?

Definition at line 283 of file AddressBase.cpp.

References getOnExhaust(), and org::xmlBlaster::util::Constants::ONEXHAUST_KILL_SESSION.

long org::xmlBlaster::util::qos::address::AddressBase::getCollectTime (  ) 

BurstMode: The time span to collect messages before sending.

Returns:
The time to collect in milliseconds

Definition at line 292 of file AddressBase.cpp.

References collectTime_.

Referenced by getSettings().

void org::xmlBlaster::util::qos::address::AddressBase::setCollectTime ( long  collectTime  ) 

BurstMode: The time to collect messages for sending in a bulk.

Parameters:
The time to collect in milliseconds

Definition at line 301 of file AddressBase.cpp.

References collectTime_.

int org::xmlBlaster::util::qos::address::AddressBase::getBurstModeMaxEntries (  ) 

How many messages maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.

-1 is unlimited (all of the available messages with same priority are send)

Definition at line 307 of file AddressBase.cpp.

References burstModeMaxEntries_.

void org::xmlBlaster::util::qos::address::AddressBase::setBurstModeMaxEntries ( int  burstModeMaxEntries  ) 

How many messages maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.

Parameters:
-1 takes all available messages from highest priority in a bulk (default) only limited by burstModeMaxBytes; Defaults to 1

Definition at line 312 of file AddressBase.cpp.

References burstModeMaxEntries_, log_, ME, and org::xmlBlaster::util::I_Log::warn().

long org::xmlBlaster::util::qos::address::AddressBase::getBurstModeMaxBytes (  ) 

How many bytes maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.

Definition at line 326 of file AddressBase.cpp.

References burstModeMaxBytes_.

void org::xmlBlaster::util::qos::address::AddressBase::setBurstModeMaxBytes ( long  BurstModeMaxBytes  ) 

How many bytes maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.

Parameters:
-1 takes all available messages from highest priority in a bulk (default) only limited by burstModeMaxEntries

Definition at line 331 of file AddressBase.cpp.

References burstModeMaxBytes_.

long org::xmlBlaster::util::qos::address::AddressBase::getPingInterval (  ) 

How long to wait between pings to the callback server.

Returns:
The pause time between pings in millis

Definition at line 341 of file AddressBase.cpp.

References pingInterval_.

Referenced by org::xmlBlaster::util::qos::address::Address::getSettings().

void org::xmlBlaster::util::qos::address::AddressBase::setPingInterval ( long  pingInterval  ) 

How long to wait between pings to the callback server.

Parameters:
pingInterval The pause time between pings in millis

Definition at line 350 of file AddressBase.cpp.

References log_, ME, pingInterval_, and org::xmlBlaster::util::I_Log::warn().

int org::xmlBlaster::util::qos::address::AddressBase::getRetries (  ) 

How often shall we retry callback attempt on callback failure.

Returns:
-1 forever, 0 no retry, > 0 number of retries

Definition at line 364 of file AddressBase.cpp.

References retries_.

Referenced by org::xmlBlaster::util::qos::address::Address::getSettings().

void org::xmlBlaster::util::qos::address::AddressBase::setRetries ( int  retries  ) 

How often shall we retry callback attempt on callback failure.

Parameters:
-1 forever, 0 no retry, > 0 number of retries

Definition at line 373 of file AddressBase.cpp.

References retries_.

long org::xmlBlaster::util::qos::address::AddressBase::getDelay (  ) 

Delay between callback retries in milliseconds, defaults to one minute.

Returns:
The delay in millisconds

Definition at line 383 of file AddressBase.cpp.

References delay_.

Referenced by org::xmlBlaster::util::qos::address::Address::getSettings().

void org::xmlBlaster::util::qos::address::AddressBase::setDelay ( long  delay  ) 

Delay between callback retries in milliseconds, defaults to one minute.

Definition at line 391 of file AddressBase.cpp.

References delay_.

Referenced by org::xmlBlaster::util::EmbeddedServer::start(), and org::xmlBlaster::util::EmbeddedServer::stop().

bool org::xmlBlaster::util::qos::address::AddressBase::oneway (  ) 

Shall the publish() or callback update() message be oneway.

Is only with CORBA and our native SOCKET protocol supported

Returns:
true if you want to force oneway sending

Definition at line 402 of file AddressBase.cpp.

References oneway_.

void org::xmlBlaster::util::qos::address::AddressBase::setOneway ( bool  oneway  ) 

Shall the publish() or callback update() message be oneway.

Is only with CORBA and our native SOCKET protocol supported

Parameters:
oneway false is default

Definition at line 412 of file AddressBase.cpp.

References oneway_.

void org::xmlBlaster::util::qos::address::AddressBase::setDispatcherActive ( bool  dispatcherActive  ) 

Inhibits/activates the delivery of asynchronous dispatches of messages.

Parameters:
dispatcherActive 

Definition at line 422 of file AddressBase.cpp.

References dispatcherActive_.

bool org::xmlBlaster::util::qos::address::AddressBase::isDispatcherActive (  ) 

Returns:
true if the dispatcher is currently activated, i.e.

if it is able to deliver asynchronous messages from the queue.

Definition at line 417 of file AddressBase.cpp.

References dispatcherActive_.

void org::xmlBlaster::util::qos::address::AddressBase::setPtpAllowed ( bool  ptpAllowed  ) 

Parameters:
Set if we accept point to point messages

Definition at line 430 of file AddressBase.cpp.

References ptpAllowed_.

bool org::xmlBlaster::util::qos::address::AddressBase::isPtpAllowed (  ) 

Returns:
true if we may send PtP messages

Definition at line 438 of file AddressBase.cpp.

References ptpAllowed_.

void org::xmlBlaster::util::qos::address::AddressBase::setCompressType ( std::string &  compressType  ) 

string org::xmlBlaster::util::qos::address::AddressBase::getSecretSessionId (  ) 

The identifier sent to the callback client, the client can decide if he trusts this invocation.

Returns:
never null

Definition at line 456 of file AddressBase.cpp.

References sessionId_.

void org::xmlBlaster::util::qos::address::AddressBase::setSecretSessionId ( std::string &  sessionId  ) 

The identifier sent to the callback client, the client can decide if he trusts this invocation.

string org::xmlBlaster::util::qos::address::AddressBase::getCompressType (  ) 

Get the compression method.

Returns:
"" No compression

Definition at line 471 of file AddressBase.cpp.

References compressType_.

long org::xmlBlaster::util::qos::address::AddressBase::getMinSize (  ) 

Messages bigger this size in bytes are compressed.


Note: This value is only used if compressType is set to a supported value

Returns:
size in bytes

Definition at line 482 of file AddressBase.cpp.

References minSize_.

void org::xmlBlaster::util::qos::address::AddressBase::setMinSize ( long  minSize  ) 

Messages bigger this size in bytes are compressed.


Note: This value is only evaluated if compressType is set to a supported value

Returns:
size in bytes

Definition at line 493 of file AddressBase.cpp.

References minSize_.

void org::xmlBlaster::util::qos::address::AddressBase::setDispatchPlugin ( std::string &  dispatchPlugin  ) 

Specify your dispatcher plugin configuration.

Set to "undef" to switch off, or to e.g. "Priority,1.0" to access the PriorizedDispatchPlugin

This overwrites the xmlBlaster.properties default setting e.g.:

 DispatchPlugin[Priority][1.0]=org.xmlBlaster.util.dispatch.plugins.prio.PriorizedDispatchPlugin
 DispatchPlugin[SlowMotion][1.0]=org.xmlBlaster.util.dispatch.plugins.motion.SlowMotion
 DispatchPlugin/defaultPlugin=Priority,1.0
 
See also:
The dispatch.control.plugin requirement

string org::xmlBlaster::util::qos::address::AddressBase::getDispatchPlugin (  ) 

Returns:
"undef" or e.g.

"Priority,1.0"

Definition at line 521 of file AddressBase.cpp.

References dispatchPlugin_.

ClientPropertyMap& org::xmlBlaster::util::qos::address::AddressBase::getClientProperties (  ) 

std::string org::xmlBlaster::util::qos::address::AddressBase::toXml ( std::string &  extraOffset = ""  ) 

Dump state of this object into a XML ASCII std::string.


Only none default values are dumped for performance reasons

Parameters:
extraOffset indenting of tags for nice output
Returns:
The xml representation


Friends And Related Function Documentation

friend class AddressFactory [friend]

Definition at line 52 of file AddressBase.h.


Member Data Documentation

std::string org::xmlBlaster::util::qos::address::AddressBase::ME [protected]

Definition at line 68 of file AddressBase.h.

Referenced by copy(), setBurstModeMaxEntries(), and setPingInterval().

org::xmlBlaster::util::Global& org::xmlBlaster::util::qos::address::AddressBase::global_ [protected]

Definition at line 69 of file AddressBase.h.

Referenced by getHostname().

org::xmlBlaster::util::I_Log& org::xmlBlaster::util::qos::address::AddressBase::log_ [protected]

Definition at line 70 of file AddressBase.h.

Referenced by setBurstModeMaxEntries(), and setPingInterval().

std::string org::xmlBlaster::util::qos::address::AddressBase::rootTag_ [protected]

Definition at line 72 of file AddressBase.h.

Referenced by copy().

std::string org::xmlBlaster::util::qos::address::AddressBase::nodeId_ [protected]

The node id to which we want to connect.

Definition at line 75 of file AddressBase.h.

Referenced by copy().

long org::xmlBlaster::util::qos::address::AddressBase::maxEntries_ [protected]

TODO: Move this attribute to CbQueueProperty.java.

Definition at line 78 of file AddressBase.h.

Referenced by copy(), org::xmlBlaster::util::qos::address::Address::getMaxEntries(), and org::xmlBlaster::util::qos::address::Address::setMaxEntries().

std::string org::xmlBlaster::util::qos::address::AddressBase::address_ [mutable, protected]

The unique address, e.g.

the CORBA IOR std::string

Definition at line 81 of file AddressBase.h.

Referenced by copy(), getHostname(), getRawAddress(), and setPort().

std::string org::xmlBlaster::util::qos::address::AddressBase::hostname_ [mutable, protected]

Definition at line 83 of file AddressBase.h.

Referenced by copy(), getHostname(), and hasHostname().

bool org::xmlBlaster::util::qos::address::AddressBase::isHardcodedHostname_ [protected]

Definition at line 84 of file AddressBase.h.

Referenced by copy(), and isHardcodedHostname().

std::string org::xmlBlaster::util::qos::address::AddressBase::type_ [protected]

The unique protocol type, e.g.

"IOR"

Definition at line 87 of file AddressBase.h.

Referenced by copy(), getSettings(), and getType().

std::string org::xmlBlaster::util::qos::address::AddressBase::version_ [protected]

The protocol version, e.g.

"1.0"

Definition at line 90 of file AddressBase.h.

Referenced by copy(), and getVersion().

long org::xmlBlaster::util::qos::address::AddressBase::collectTime_ [protected]

BurstMode: The time to collect messages for publish/update.

Definition at line 93 of file AddressBase.h.

Referenced by copy(), getCollectTime(), and setCollectTime().

int org::xmlBlaster::util::qos::address::AddressBase::burstModeMaxEntries_ [protected]

How many messages maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.

Defaults to all available of highest priority

Definition at line 100 of file AddressBase.h.

Referenced by getBurstModeMaxEntries(), and setBurstModeMaxEntries().

long org::xmlBlaster::util::qos::address::AddressBase::burstModeMaxBytes_ [protected]

How many bytes maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.

Definition at line 106 of file AddressBase.h.

Referenced by getBurstModeMaxBytes(), and setBurstModeMaxBytes().

long org::xmlBlaster::util::qos::address::AddressBase::pingInterval_ [protected]

Ping interval: pinging every given milliseconds.

Definition at line 109 of file AddressBase.h.

Referenced by copy(), getPingInterval(), and setPingInterval().

int org::xmlBlaster::util::qos::address::AddressBase::retries_ [protected]

How often to retry if connection fails.

Definition at line 112 of file AddressBase.h.

Referenced by copy(), getRetries(), and setRetries().

long org::xmlBlaster::util::qos::address::AddressBase::delay_ [protected]

Delay between connection retries in milliseconds.

Definition at line 115 of file AddressBase.h.

Referenced by copy(), getDelay(), and setDelay().

bool org::xmlBlaster::util::qos::address::AddressBase::oneway_ [protected]

Shall the update() or publish() messages be send oneway (no application level ACK).

For more info read the CORBA spec. Only CORBA and our native SOCKET protocol support oneway. Defaults to false (the update() or publish() has a return value and can throw an exception).

Definition at line 123 of file AddressBase.h.

Referenced by copy(), getSettings(), oneway(), and setOneway().

bool org::xmlBlaster::util::qos::address::AddressBase::dispatcherActive_ [protected]

Control if the dispatcher is activated on login, i.e.

if it is able to deliver asynchronous messages from the queue. defaults to true

Definition at line 130 of file AddressBase.h.

Referenced by copy(), isDispatcherActive(), and setDispatcherActive().

std::string org::xmlBlaster::util::qos::address::AddressBase::compressType_ [protected]

Compress messages if set to "gzip" or "zip".

Definition at line 133 of file AddressBase.h.

Referenced by copy(), and getCompressType().

long org::xmlBlaster::util::qos::address::AddressBase::minSize_ [protected]

Messages bigger this size in bytes are compressed.

Definition at line 136 of file AddressBase.h.

Referenced by copy(), getMinSize(), and setMinSize().

bool org::xmlBlaster::util::qos::address::AddressBase::ptpAllowed_ [protected]

PtP messages wanted? Defaults to true, false prevents spamming.

Definition at line 139 of file AddressBase.h.

Referenced by copy(), isPtpAllowed(), and setPtpAllowed().

std::string org::xmlBlaster::util::qos::address::AddressBase::sessionId_ [protected]

The identifier sent to the callback client, the client can decide if he trusts this invocation.

Definition at line 142 of file AddressBase.h.

Referenced by copy(), and getSecretSessionId().

bool org::xmlBlaster::util::qos::address::AddressBase::useForSubjectQueue_ [protected]

Shall this session callback be used for subjectQueue messages as well? For <callback> only.

Definition at line 145 of file AddressBase.h.

Referenced by copy(), and org::xmlBlaster::util::qos::address::CallbackAddress::useForSubjectQueue().

std::string org::xmlBlaster::util::qos::address::AddressBase::dispatchPlugin_ [protected]

Does client whish a dispatcher plugin.

Set to "undef" forces to switch off, or e.g. "Priority,1.0" to access the PriorizedDispatchPlugin

Setting it to 'null' (which is the default) lets the server choose the plugin

See also:
The dispatch.control.plugin requirement

Definition at line 157 of file AddressBase.h.

Referenced by copy(), and getDispatchPlugin().

ClientPropertyMap org::xmlBlaster::util::qos::address::AddressBase::attributes_ [protected]

Definition at line 159 of file AddressBase.h.

Referenced by addAttribute(), copy(), and getAttributes().

long org::xmlBlaster::util::qos::address::AddressBase::defaultPingInterval_ [protected]

Definition at line 169 of file AddressBase.h.

Referenced by copy(), org::xmlBlaster::util::qos::address::CallbackAddress::usage(), and org::xmlBlaster::util::qos::address::Address::usage().

int org::xmlBlaster::util::qos::address::AddressBase::defaultRetries_ [protected]

Definition at line 170 of file AddressBase.h.

Referenced by copy(), org::xmlBlaster::util::qos::address::CallbackAddress::usage(), and org::xmlBlaster::util::qos::address::Address::usage().

long org::xmlBlaster::util::qos::address::AddressBase::defaultDelay_ [protected]

Definition at line 171 of file AddressBase.h.

Referenced by copy(), org::xmlBlaster::util::qos::address::CallbackAddress::usage(), and org::xmlBlaster::util::qos::address::Address::usage().


The documentation for this class was generated from the following files: