org::xmlBlaster::util::Destination

org::xmlBlaster::util::Destination Class Reference

Holding destination address attributes. More...

Collaboration diagram for org::xmlBlaster::util::Destination:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Destination (org::xmlBlaster::util::Global &global, org::xmlBlaster::util::SessionName &sessionName, std::string &queryType="EXACT", bool forceQueuing=false)
 Constructs the specialized quality of service destination object.
 Destination (org::xmlBlaster::util::Global &global, std::string &address="", std::string &queryType="EXACT", bool forceQueuing=false)
 Destination (Destination &dest)
Destination & operator= (Destination &dest)
bool isXPathQuery ()
 
Returns:
true/false

bool isExactAddress ()
 
Returns:
true/false

bool forceQueuing ()
 
Returns:
true/false

void forceQueuing (bool forceQueuing)
 Set queuing of messages.
org::xmlBlaster::util::SessionNameRef getDestination ()
 
Parameters:
The destination address or XPath query std::string

void setQueryType (std::string &queryType)
 
Parameters:
queryType The query type, one of "EXACT" | "XPATH"

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

Detailed Description

Holding destination address attributes.

This class corresponds to the QOS destination tag

Definition at line 23 of file Destination.h.

Constructor & Destructor Documentation

org::xmlBlaster::util::Destination::Destination ( org::xmlBlaster::util::Global &  global,
org::xmlBlaster::util::SessionName &  sessionName,
std::string &  queryType = "EXACT",
bool  forceQueuing = false 
)

Constructs the specialized quality of service destination object.

org::xmlBlaster::util::Destination::Destination ( org::xmlBlaster::util::Global &  global,
std::string &  address = "",
std::string &  queryType = "EXACT",
bool  forceQueuing = false 
)

org::xmlBlaster::util::Destination::Destination ( Destination &  dest  ) 

Definition at line 48 of file Destination.cpp.

Member Function Documentation

Destination & org::xmlBlaster::util::Destination::operator= ( Destination &  dest  ) 

Definition at line 54 of file Destination.cpp.

bool org::xmlBlaster::util::Destination::isXPathQuery (  ) 

Returns:
true/false

Definition at line 60 of file Destination.cpp.

bool org::xmlBlaster::util::Destination::isExactAddress (  ) 

Returns:
true/false

Definition at line 65 of file Destination.cpp.

bool org::xmlBlaster::util::Destination::forceQueuing (  ) 

Returns:
true/false

Definition at line 70 of file Destination.cpp.

Referenced by PublishDemo::publish().

void org::xmlBlaster::util::Destination::forceQueuing ( bool  forceQueuing  ) 

Set queuing of messages.

true: If client is not logged in, messages will be queued until he comes.
false: Default is that on PtP messages when the destination address is not online, an Exception is thrown

Definition at line 75 of file Destination.cpp.

SessionNameRef org::xmlBlaster::util::Destination::getDestination (  ) 

Parameters:
The destination address or XPath query std::string

Definition at line 87 of file Destination.cpp.

void org::xmlBlaster::util::Destination::setQueryType ( std::string &  queryType  ) 

Parameters:
queryType The query type, one of "EXACT" | "XPATH"

std::string org::xmlBlaster::util::Destination::toXml ( std::string &  extraOffset = ""  ) 

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


Parameters:
extraOffset indenting of tags for nice output
Returns:
The Destination as a XML ASCII std::string

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