org::xmlBlaster::util::cluster::NodeInfo Class Reference

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 NodeInfo (org::xmlBlaster::util::Global &global, org::xmlBlaster::util::cluster::NodeId nodeId)
 This class holds the address informations about an xmlBlaster server instance (=cluster node).
 NodeInfo (NodeInfo &info)
NodeInfooperator= (NodeInfo &info)
std::string getId ()
 
Returns:
The unique name of the managed xmlBlaster instance e.g.

org::xmlBlaster::util::cluster::NodeId getNodeId ()
 
Returns:
The unique name of the managed xmlBlaster instance.

void setNodeId (org::xmlBlaster::util::cluster::NodeId nodeId)
 
Parameters:
The unique name of the managed xmlBlaster instance

org::xmlBlaster::util::qos::address::AddressBaseRef getAddress ()
 Access the currently used address to access the node.
void addAddress (org::xmlBlaster::util::qos::address::AddressBaseRef &address)
 Add another address for this cluster node.
AddressMap getAddressMap ()
 Access all addresses of a node, please handle as readonly.
bool contains (org::xmlBlaster::util::qos::address::AddressBaseRef &other)
 Does the given address belong to this node?
org::xmlBlaster::util::qos::address::AddressBaseRef getCbAddress ()
 Access the currently used callback address for this node.
AddressMap getCbAddressMap ()
 Currently not used.
void addCbAddress (org::xmlBlaster::util::qos::address::AddressBaseRef &cbAddress)
 Add another callback address for this cluster node.
bool isNameService ()
 Is the node acting as a preferred cluster naming service.
void setNameService (bool nameService)
 Tag this node as a cluster naming service.
NodeMap getBackupnodeMap ()
 If this node is not accessible, we can use its backup nodes.
void addBackupnode (org::xmlBlaster::util::cluster::NodeId &backupId)
 Set backup nodes.
std::string toXml (std::string &extraOffset="")
 Dump state of this object into a XML ASCII std::string.

Detailed Description

Definition at line 27 of file NodeInfo.h.


Constructor & Destructor Documentation

org::xmlBlaster::util::cluster::NodeInfo::NodeInfo ( org::xmlBlaster::util::Global global,
org::xmlBlaster::util::cluster::NodeId  nodeId 
)

This class holds the address informations about an xmlBlaster server instance (=cluster node).

Definition at line 27 of file NodeInfo.cpp.

org::xmlBlaster::util::cluster::NodeInfo::NodeInfo ( NodeInfo info  ) 

Definition at line 35 of file NodeInfo.cpp.


Member Function Documentation

NodeInfo & org::xmlBlaster::util::cluster::NodeInfo::operator= ( NodeInfo info  ) 

Definition at line 44 of file NodeInfo.cpp.

string org::xmlBlaster::util::cluster::NodeInfo::getId (  ) 

Returns:
The unique name of the managed xmlBlaster instance e.g.

"bilbo.mycompany.com"

Definition at line 53 of file NodeInfo.cpp.

References org::xmlBlaster::util::cluster::NodeId::getId().

NodeId org::xmlBlaster::util::cluster::NodeInfo::getNodeId (  ) 

Returns:
The unique name of the managed xmlBlaster instance.

Definition at line 61 of file NodeInfo.cpp.

void org::xmlBlaster::util::cluster::NodeInfo::setNodeId ( org::xmlBlaster::util::cluster::NodeId  nodeId  ) 

Parameters:
The unique name of the managed xmlBlaster instance

Definition at line 69 of file NodeInfo.cpp.

AddressBaseRef org::xmlBlaster::util::cluster::NodeInfo::getAddress (  ) 

Access the currently used address to access the node.

Returns:
null if not specified

Definition at line 78 of file NodeInfo.cpp.

void org::xmlBlaster::util::cluster::NodeInfo::addAddress ( org::xmlBlaster::util::qos::address::AddressBaseRef address  ) 

Add another address for this cluster node.

The std::map is sorted with the same sequence as the given XML sequence

Definition at line 89 of file NodeInfo.cpp.

AddressMap org::xmlBlaster::util::cluster::NodeInfo::getAddressMap (  ) 

Access all addresses of a node, please handle as readonly.

Definition at line 97 of file NodeInfo.cpp.

bool org::xmlBlaster::util::cluster::NodeInfo::contains ( org::xmlBlaster::util::qos::address::AddressBaseRef other  ) 

Does the given address belong to this node?

Definition at line 105 of file NodeInfo.cpp.

AddressBaseRef org::xmlBlaster::util::cluster::NodeInfo::getCbAddress (  ) 

Access the currently used callback address for this node.

Returns:
Never null, returns a default if none specified

Definition at line 115 of file NodeInfo.cpp.

References addCbAddress().

AddressMap org::xmlBlaster::util::cluster::NodeInfo::getCbAddressMap (  ) 

Currently not used.

Definition at line 126 of file NodeInfo.cpp.

void org::xmlBlaster::util::cluster::NodeInfo::addCbAddress ( org::xmlBlaster::util::qos::address::AddressBaseRef cbAddress  ) 

Add another callback address for this cluster node.

Definition at line 134 of file NodeInfo.cpp.

Referenced by getCbAddress().

bool org::xmlBlaster::util::cluster::NodeInfo::isNameService (  ) 

Is the node acting as a preferred cluster naming service.

NOTE: This mode is currently not supported

Definition at line 144 of file NodeInfo.cpp.

void org::xmlBlaster::util::cluster::NodeInfo::setNameService ( bool  nameService  ) 

Tag this node as a cluster naming service.

NOTE: This mode is currently not supported

Definition at line 154 of file NodeInfo.cpp.

NodeMap org::xmlBlaster::util::cluster::NodeInfo::getBackupnodeMap (  ) 

If this node is not accessible, we can use its backup nodes.

Returns:
a Map containing org::xmlBlaster::util::cluster::NodeId objects

Definition at line 163 of file NodeInfo.cpp.

void org::xmlBlaster::util::cluster::NodeInfo::addBackupnode ( org::xmlBlaster::util::cluster::NodeId backupId  ) 

Set backup nodes.

Definition at line 171 of file NodeInfo.cpp.

References org::xmlBlaster::util::cluster::NodeId::getId().

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

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: