OverSim
BootstrapNodeHandle Class Reference

#include <BootstrapNodeHandle.h>

Inheritance diagram for BootstrapNodeHandle:
NodeHandle TransportAddress

Public Member Functions

 BootstrapNodeHandle ()
 BootstrapNodeHandle (const BootstrapNodeHandle &handle)
 BootstrapNodeHandle (const NodeHandle &handle, BootstrapNodePrioType prio=CACHE)
 BootstrapNodeHandle (const OverlayKey &key, const IPvXAddress &ip, int port, BootstrapNodePrioType prio=CACHE)
BootstrapNodePrioType getNodePrio () const
void setNodePrio (BootstrapNodePrioType nodePrio)
simtime_t getLastPing () const
void setLastPing (simtime_t lastPing)
- 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
NodeHandleoperator= (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 OverlayKeygetKey () 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 TransportAddressdup () 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
TransportAddressoperator= (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 TransportAddressVectorgetSourceRoute () const
 Returns source route used to reach this node.
size_t hash () const
 creates a hash value of ip and port

Private Attributes

BootstrapNodePrioType nodePrio
simtime_t lastPing

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
- Protected Attributes inherited from NodeHandle
OverlayKey key
 the OverlayKey of this NodeHandle

Detailed Description

Definition at line 33 of file BootstrapNodeHandle.h.

Constructor & Destructor Documentation

BootstrapNodeHandle::BootstrapNodeHandle ( )
inline

Definition at line 40 of file BootstrapNodeHandle.h.

{
/* lowest priority */
}
BootstrapNodeHandle::BootstrapNodeHandle ( const BootstrapNodeHandle handle)
inline

Definition at line 46 of file BootstrapNodeHandle.h.

: NodeHandle(handle)
{
nodePrio = handle.nodePrio;
}
BootstrapNodeHandle::BootstrapNodeHandle ( const NodeHandle handle,
BootstrapNodePrioType  prio = CACHE 
)
inline

Definition at line 51 of file BootstrapNodeHandle.h.

{
this->ip = handle.getIp();
this->port = handle.getPort();
this->key = handle.getKey();
nodePrio = prio;
}
BootstrapNodeHandle::BootstrapNodeHandle ( const OverlayKey key,
const IPvXAddress &  ip,
int  port,
BootstrapNodePrioType  prio = CACHE 
)
inline

Definition at line 60 of file BootstrapNodeHandle.h.

: NodeHandle(key, ip, port) {
nodePrio = prio;
}

Member Function Documentation

simtime_t BootstrapNodeHandle::getLastPing ( ) const
inline
BootstrapNodePrioType BootstrapNodeHandle::getNodePrio ( ) const
inline

Definition at line 68 of file BootstrapNodeHandle.h.

Referenced by BootstrapList::insertBootstrapCandidate(), and operator<<().

{
return nodePrio;
}
void BootstrapNodeHandle::setLastPing ( simtime_t  lastPing)
inline

Definition at line 80 of file BootstrapNodeHandle.h.

Referenced by BootstrapList::insertBootstrapCandidate().

{
this->lastPing = lastPing;
}
void BootstrapNodeHandle::setNodePrio ( BootstrapNodePrioType  nodePrio)
inline

Definition at line 72 of file BootstrapNodeHandle.h.

{
this->nodePrio = nodePrio;
}

Member Data Documentation

simtime_t BootstrapNodeHandle::lastPing
private

Definition at line 37 of file BootstrapNodeHandle.h.

Referenced by getLastPing(), and setLastPing().

BootstrapNodePrioType BootstrapNodeHandle::nodePrio
private

Definition at line 36 of file BootstrapNodeHandle.h.

Referenced by BootstrapNodeHandle(), getNodePrio(), and setNodePrio().


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