org::xmlBlaster::util::cluster::RouteInfo Class Reference

This class holds the information about a route node which the message passed. More...

Collaboration diagram for org::xmlBlaster::util::cluster::RouteInfo:

[legend]List of all members.

Public Member Functions
	RouteInfo (org::xmlBlaster::util::Global &global)
	RouteInfo (const org::xmlBlaster::util::cluster::NodeId &nodeId, int stratum, Timestamp timestamp)
	Parameters: nodeId  The unique name of the xmlBlaster instance
void	setNodeId (const org::xmlBlaster::util::cluster::NodeId &nodeId)
	The unique node name of the xmlBlaster instance.
org::xmlBlaster::util::cluster::NodeId	getNodeId () const
	The unique node name of the xmlBlaster instance.
std::string	getId () const
	The unique node name of the xmlBlaster instance.
void	setStratum (int stratum)
	The distance from the current xmlBlaster node from the master node (for this message).
int	getStratum () const
	The distance from the current xmlBlaster node from the master node (for this message).
void	setTimestamp (Timestamp timestamp)
	Message receive timestamp in nano seconds.
Timestamp	getTimestamp () const
	Message receive timestamp in nano seconds.
void	setDirtyRead (bool dirtyRead)
	Parameters: dirtyRead  true if cluster slaves cache forwarded publish messages
bool	getDirtyRead () const
std::string	toXml (const std::string &extraOffset="") const
	Dump state of this object into a XML ASCII std::string.

---

Detailed Description

This class holds the information about a route node which the message passed.

Author:

xmlBlaster@marcelruff.info

laghi@swissinfo.org

Definition at line 20 of file RouteInfo.h.

---

Constructor & Destructor Documentation

org::xmlBlaster::util::cluster::RouteInfo::RouteInfo

(

org::xmlBlaster::util::Global &

global

)

Definition at line 18 of file RouteInfo.cpp.

org::xmlBlaster::util::cluster::RouteInfo::RouteInfo	(	const org::xmlBlaster::util::cluster::NodeId &	nodeId,
		int	stratum,
		Timestamp	timestamp
	)

Parameters:

nodeId

The unique name of the xmlBlaster instance

Parameters:

	stratum	The distance from the node to the master node, if you don't know it set it to 0.
	timestamp	The receive timestamp of the message (nano seconds)

---

Member Function Documentation

void org::xmlBlaster::util::cluster::RouteInfo::setNodeId

(

const org::xmlBlaster::util::cluster::NodeId &

nodeId

)

The unique node name of the xmlBlaster instance.

org::xmlBlaster::util::cluster::NodeId org::xmlBlaster::util::cluster::RouteInfo::getNodeId

(

)

const

The unique node name of the xmlBlaster instance.

std::string org::xmlBlaster::util::cluster::RouteInfo::getId

(

)

const

The unique node name of the xmlBlaster instance.

Parameters:

The

std::string representation of my name

void org::xmlBlaster::util::cluster::RouteInfo::setStratum

(

int

stratum

)

The distance from the current xmlBlaster node from the master node (for this message).

Definition at line 49 of file RouteInfo.cpp.

int org::xmlBlaster::util::cluster::RouteInfo::getStratum

(

)

const

The distance from the current xmlBlaster node from the master node (for this message).

Referenced by org::xmlBlaster::util::qos::QosData::addRouteInfo().

void org::xmlBlaster::util::cluster::RouteInfo::setTimestamp

(

Timestamp

timestamp

)

Message receive timestamp in nano seconds.

Definition at line 59 of file RouteInfo.cpp.

Timestamp org::xmlBlaster::util::cluster::RouteInfo::getTimestamp

(

)

const

Message receive timestamp in nano seconds.

void org::xmlBlaster::util::cluster::RouteInfo::setDirtyRead

(

bool

dirtyRead

)

Parameters:

dirtyRead

true if cluster slaves cache forwarded publish messages

See also:

The cluster.dirtyRead requirement

Definition at line 69 of file RouteInfo.cpp.

bool org::xmlBlaster::util::cluster::RouteInfo::getDirtyRead

(

)

const

std::string org::xmlBlaster::util::cluster::RouteInfo::toXml

(

const std::string &

extraOffset = ""

)

const

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

Parameters:

extraOffset

indenting of tags for nice output

---

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

• util/cluster/RouteInfo.h
• util/cluster/RouteInfo.cpp