ariba::overlay::OneHop Class Reference

#include <source/ariba/overlay/modules/onehop/OneHop.h>

Inherits ariba::overlay::OverlayInterface, and ariba::utility::Timer.

Collaboration diagram for ariba::overlay::OneHop:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 OneHop (BaseOverlay &_overlay, const NodeID &_nodeid, OverlayStructureEvents *_eventsReceiver, const OverlayParameterSet &param)
virtual ~OneHop ()

Protected Member Functions

virtual void eventFunction ()
virtual void createOverlay ()
virtual void deleteOverlay ()
virtual void joinOverlay (const EndpointDescriptor &boot=EndpointDescriptor::UNSPECIFIED())
virtual void leaveOverlay ()
virtual const EndpointDescriptorresolveNode (const NodeID &node)
virtual bool isClosestNodeTo (const NodeID &node)
virtual const LinkIDgetNextLinkId (const NodeID &id) const
virtual void routeMessage (const NodeID &destnode, Message *msg)
virtual void routeMessage (const NodeID &node, const LinkID &link, Message *msg)
virtual NodeList getKnownNodes (bool deep=true) const
virtual void onLinkUp (const LinkID &lnk, const NodeID &remote)
virtual void onLinkDown (const LinkID &lnk, const NodeID &remote)
virtual void onMessage (const DataMessage &msg, const NodeID &remote, const LinkID &lnk=LinkID::UNSPECIFIED)

Private Types

enum  _OneHopState { OneHopStateInvalid = 0, OneHopStateCompleted = 1 }
 

The current state of the overlay.

More...
typedef map< const NodeID,
const LinkID
OverlayNodeMapping
 The other nodes in the overlay.
typedef enum
ariba::overlay::OneHop::_OneHopState 
OneHopState
 The current state of the overlay.

Private Member Functions

 use_logging_h (OneHop)

Private Attributes

OverlayNodeMapping overlayNodes
OneHopState state
vector< LinkIDbootstrapLinks

Detailed Description

Definition at line 53 of file OneHop.h.


Member Typedef Documentation

The current state of the overlay.

typedef map<const NodeID, const LinkID> ariba::overlay::OneHop::OverlayNodeMapping [private]

The other nodes in the overlay.

Definition at line 109 of file OneHop.h.


Member Enumeration Documentation

The current state of the overlay.

Enumerator:
OneHopStateInvalid 
OneHopStateCompleted 

Definition at line 113 of file OneHop.h.


Constructor & Destructor Documentation

ariba::overlay::OneHop::OneHop ( BaseOverlay _overlay,
const NodeID _nodeid,
OverlayStructureEvents _eventsReceiver,
const OverlayParameterSet param 
)
ariba::overlay::OneHop::~OneHop (  )  [virtual]

Definition at line 65 of file OneHop.cpp.

References deleteOverlay(), and ariba::utility::Timer::stop().


Member Function Documentation

void ariba::overlay::OneHop::createOverlay (  )  [protected, virtual]
See also:
OverlayInterface.h

Implements ariba::overlay::OverlayInterface.

Definition at line 124 of file OneHop.cpp.

References logging_info.

void ariba::overlay::OneHop::deleteOverlay (  )  [protected, virtual]
See also:
OverlayInterface.h

Implements ariba::overlay::OverlayInterface.

Definition at line 130 of file OneHop.cpp.

References logging_info, OneHopStateInvalid, and state.

Referenced by ~OneHop().

void ariba::overlay::OneHop::eventFunction (  )  [protected, virtual]
OverlayInterface::NodeList ariba::overlay::OneHop::getKnownNodes ( bool  deep = true  )  const [protected, virtual]
See also:
OverlayInterface.h

Implements ariba::overlay::OverlayInterface.

Definition at line 136 of file OneHop.cpp.

References overlayNodes.

const LinkID & ariba::overlay::OneHop::getNextLinkId ( const NodeID id  )  const [protected, virtual]
bool ariba::overlay::OneHop::isClosestNodeTo ( const NodeID node  )  [protected, virtual]
See also:
OverlayInterface.h

Implements ariba::overlay::OverlayInterface.

Definition at line 83 of file OneHop.cpp.

void ariba::overlay::OneHop::joinOverlay ( const EndpointDescriptor boot = EndpointDescriptor::UNSPECIFIED()  )  [protected, virtual]
void ariba::overlay::OneHop::leaveOverlay (  )  [protected, virtual]
void ariba::overlay::OneHop::onLinkDown ( const LinkID lnk,
const NodeID remote 
) [protected, virtual]
void ariba::overlay::OneHop::onLinkUp ( const LinkID lnk,
const NodeID remote 
) [protected, virtual]
void ariba::overlay::OneHop::onMessage ( const DataMessage msg,
const NodeID remote,
const LinkID lnk = LinkID::UNSPECIFIED 
) [protected, virtual]
const EndpointDescriptor & ariba::overlay::OneHop::resolveNode ( const NodeID node  )  [protected, virtual]
void ariba::overlay::OneHop::routeMessage ( const NodeID node,
const LinkID link,
Message msg 
) [protected, virtual]
void ariba::overlay::OneHop::routeMessage ( const NodeID destnode,
Message msg 
) [protected, virtual]
ariba::overlay::OneHop::use_logging_h ( OneHop   )  [private]

Reimplemented from ariba::utility::Timer.


Member Data Documentation

Definition at line 119 of file OneHop.h.

Referenced by joinOverlay(), and onLinkDown().

Definition at line 118 of file OneHop.h.

Referenced by deleteOverlay(), joinOverlay(), leaveOverlay(), and onLinkDown().


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

Generated on Fri Dec 10 11:09:25 2010 for Ariba by  doxygen 1.6.1