MarkedNodeHandle Class Reference

#include <KademliaNodeHandle.h>

Inheritance diagram for MarkedNodeHandle:

Public Member Functions
	MarkedNodeHandle ()
	Constructs an unspecified MarkedNodeHandle.
	MarkedNodeHandle (const NodeHandle &handle, bool isAlive=false)
bool	getIsAlive ()
void	setIsAlive (bool isAlive)
Public Member Functions inherited from NodeHandle
	NodeHandle ()
	Constructs an unspecified NodeHandle.
virtual	~NodeHandle ()
	Standard destructor.
	NodeHandle (const NodeHandle &handle)
	Copy constructor.
	NodeHandle (const OverlayKey &key, const IPvXAddress &ip, int port)
	Complete constructor.
	NodeHandle (const TransportAddress &ta)
	Constructor to generate a NodeHandle from a TransportAddress.
	NodeHandle (const OverlayKey &key, const TransportAddress &ta)
	Constructor to generate a NodeHandle from an existing OverlayKey and TransportAddress.
bool	operator== (const NodeHandle &rhs) const
	compares this NodeHandle to another given NodeHandle
bool	operator!= (const NodeHandle &rhs) const
	compares this NodeHandle to another given NodeHandle
bool	operator< (const NodeHandle &rhs) const
	compares this to a given NodeHandle
bool	operator> (const NodeHandle &rhs) const
	compares this to a given NodeHandle
bool	operator<= (const NodeHandle &rhs) const
	compares this to a given NodeHandle
bool	operator>= (const NodeHandle &rhs) const
	compares this to a given NodeHandle
NodeHandle &	operator= (const NodeHandle &rhs)
	assigns key, ip and port of rhs to this->key, this->ip and this->port
void	setKey (const OverlayKey &key)
	saves given key to NodeHandle::key
const OverlayKey &	getKey () const
	returns key of this NodeHandle
bool	isUnspecified () const
	indicates if this NodeHandle is specified
virtual void	netPack (cCommBuffer *b)
	serializes the object into a buffer
virtual void	netUnpack (cCommBuffer *b)
	deserializes the object from a buffer
virtual TransportAddress *	dup () const
	returns a copy of the NodeHandle
Public Member Functions inherited from TransportAddress
	TransportAddress ()
	Constructs a unspecified TransportAddress.
virtual	~TransportAddress ()
	Standard destructor.
	TransportAddress (const TransportAddress &handle)
	Copy constructor.
	TransportAddress (const IPvXAddress &ip, int port=-1, NatType natType=UNKNOWN_NAT)
	Complete constructor.
bool	operator== (const TransportAddress &rhs) const
	compares this to a given TransportAddress
bool	operator!= (const TransportAddress &rhs) const
	compares this to a given TransportAddress
bool	operator< (const TransportAddress &rhs) const
	compares this to a given TransportAddress
bool	operator> (const TransportAddress &rhs) const
	compares this to a given TransportAddress
bool	operator<= (const TransportAddress &rhs) const
	compares this to a given TransportAddress
bool	operator>= (const TransportAddress &rhs) const
	compares this to a given TransportAddress
TransportAddress &	operator= (const TransportAddress &rhs)
	assigns ip and port of rhs to this->ip and this->port
void	setIp (const IPvXAddress &ip, int port=-1, NatType natType=UNKNOWN_NAT)
	Sets the ip address, port and NAT type.
void	setAddress (const IPvXAddress &ip, int port=-1, NatType natType=UNKNOWN_NAT) __attribute((deprecated))
	Sets the ip address, port and NAT type.
void	appendSourceRoute (const TransportAddress &sourceRoute)
	Appends a source route to this TransportAddress.
void	clearSourceRoute ()
	Clears the source route of this TransportAddress.
void	setPort (int port)
	sets this->port to the given port
const IPvXAddress &	getIp () const
	returns ip address
const IPvXAddress &	getAddress () const __attribute((deprecated))
	returns ip address.
int	getPort () const
	returns port
NatType	getNatType () const
	returns the type of NAT this node is behind
size_t	getSourceRouteSize () const
	Returns the length of the source route to reach this node.
const TransportAddressVector &	getSourceRoute () const
	Returns source route used to reach this node.
size_t	hash () const
	creates a hash value of ip and port

Protected Attributes
bool	isAlive
Protected Attributes inherited from NodeHandle
OverlayKey	key
	the OverlayKey of this NodeHandle
Protected Attributes inherited from TransportAddress
IPvXAddress	ip
	the ip of this TransportAddress object
int	port
	the port of this TransportAddress object

Friends
std::ostream &	operator<< (std::ostream &os, const MarkedNodeHandle &n)

Additional Inherited Members
Public Types inherited from TransportAddress
enum	NatType {   UNKNOWN_NAT = 0, NO_NAT = 1, FULL_CONE_NAT = 2, PORT_RESTRICTED_NAT = 3,   SYMMETRIC_NAT = 4 }
typedef UNORDERED_SET < TransportAddress, hashFcn >	Set
	a hashed set of TransportAddresses
Static Public Attributes inherited from NodeHandle
static const NodeHandle	UNSPECIFIED_NODE
	the unspecified NodeHandle

Detailed Description

Definition at line 108 of file KademliaNodeHandle.h.

Constructor & Destructor Documentation

MarkedNodeHandle::MarkedNodeHandle ( )

inline

Constructs an unspecified MarkedNodeHandle.

Definition at line 114 of file KademliaNodeHandle.h.

    : NodeHandle()
    {
        isAlive = false;
    }

MarkedNodeHandle::MarkedNodeHandle ( const NodeHandle &  handle, bool  isAlive = false  )

inline

Definition at line 120 of file KademliaNodeHandle.h.

    : NodeHandle(handle)
    {
        this->isAlive = isAlive;
    }

Member Function Documentation

bool MarkedNodeHandle::getIsAlive ( )

inline

Definition at line 126 of file KademliaNodeHandle.h.

Referenced by Kademlia::recursiveRoutingHook().

{ return isAlive; };

void MarkedNodeHandle::setIsAlive ( bool  isAlive )

inline

Definition at line 127 of file KademliaNodeHandle.h.

Referenced by Kademlia::recursiveRoutingHook().

{ this->isAlive = isAlive; };

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const MarkedNodeHandle &  n  )

friend

Definition at line 27 of file KademliaNodeHandle.cc.

{
    if (n.ip.isUnspecified()) {
        os << "<addr unspec> ";
    } else {
        os << n.ip << ":" << n.port << " ";
    }

    if (n.key.isUnspecified()) {
        os << "<key unspec>";
    } else {
        os << n.key;
    }

    if (n.isAlive) {
        os << " ALIVE";
    } else {
        os << " NOT ALIVE";
    }

    return os;
};

Member Data Documentation

bool MarkedNodeHandle::isAlive

protected

Definition at line 132 of file KademliaNodeHandle.h.

Referenced by getIsAlive(), MarkedNodeHandle(), operator<<(), and setIsAlive().

---

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

• KademliaNodeHandle.h