OverSim
ProxNodeHandle Class Reference

#include <ProxNodeHandle.h>

Inheritance diagram for ProxNodeHandle:
NodeHandle TransportAddress KademliaBucketEntry

Public Member Functions

 ProxNodeHandle ()
 ProxNodeHandle (const NodeHandle &nodeHandle)
 ProxNodeHandle (const NodeHandle &nodeHandle, const Prox &prox)
virtual ~ProxNodeHandle ()
void setProx (Prox prox)
Prox getProx () const
- 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

Static Public Attributes

static const ProxNodeHandle UNSPECIFIED_NODE
 the unspecified ProxNodeHandle
- Static Public Attributes inherited from NodeHandle
static const NodeHandle UNSPECIFIED_NODE
 the unspecified NodeHandle
- Static Public Attributes inherited from TransportAddress
static const TransportAddress UNSPECIFIED_NODE
 TransportAddress without specified ip and port.
static const TransportAddressVector UNSPECIFIED_NODES

Protected Attributes

Prox prox
- 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

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

Detailed Description

Definition at line 65 of file ProxNodeHandle.h.

Constructor & Destructor Documentation

ProxNodeHandle::ProxNodeHandle ( )
inline

Definition at line 72 of file ProxNodeHandle.h.

{ };
ProxNodeHandle::ProxNodeHandle ( const NodeHandle nodeHandle)

Definition at line 53 of file ProxNodeHandle.cc.

: NodeHandle(nodeHandle), prox(prox)
{
//...
}
ProxNodeHandle::ProxNodeHandle ( const NodeHandle nodeHandle,
const Prox prox 
)

Definition at line 59 of file ProxNodeHandle.cc.

: NodeHandle(nodeHandle), prox(prox)
{
//...
}
virtual ProxNodeHandle::~ProxNodeHandle ( )
inlinevirtual

Definition at line 75 of file ProxNodeHandle.h.

{ };

Member Function Documentation

Prox ProxNodeHandle::getProx ( ) const
inline
void ProxNodeHandle::setProx ( Prox  prox)
inline

Definition at line 77 of file ProxNodeHandle.h.

Referenced by Kademlia::findNode(), and Kademlia::routingAdd().

{ this->prox = prox; };

Member Data Documentation

Prox ProxNodeHandle::prox
protected
const ProxNodeHandle ProxNodeHandle::UNSPECIFIED_NODE
static

the unspecified ProxNodeHandle

Definition at line 71 of file ProxNodeHandle.h.


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