ariba::overlay::OneHop Class Reference

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

Inheritance diagram for ariba::overlay::OneHop:

Inheritance graph
[legend]
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 void routeMessage (const NodeID &destnode, Message *msg)
virtual NodeList getKnownNodes () 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, OneHopStateJoinInitiated = 1, OneHopStateJoinListingRequested = 2, OneHopStateCompleted = 3 }
 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
uint16_t pendingLinks
LinkID bootstrapLink


Detailed Description

Definition at line 53 of file OneHop.h.


Member Typedef Documentation

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

The other nodes in the overlay.

Definition at line 100 of file OneHop.h.

The current state of the overlay.


Member Enumeration Documentation

The current state of the overlay.

Enumerator:
OneHopStateInvalid 
OneHopStateJoinInitiated 
OneHopStateJoinListingRequested 
OneHopStateCompleted 

Definition at line 104 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 67 of file OneHop.cpp.

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


Member Function Documentation

ariba::overlay::OneHop::use_logging_h ( OneHop   )  [private]

void ariba::overlay::OneHop::eventFunction (  )  [protected, virtual]

void ariba::overlay::OneHop::createOverlay (  )  [protected, virtual]

See also:
OverlayInterface.h

Implements ariba::overlay::OverlayInterface.

Definition at line 101 of file OneHop.cpp.

References logging_info, OneHopStateCompleted, and state.

void ariba::overlay::OneHop::deleteOverlay (  )  [protected, virtual]

See also:
OverlayInterface.h

Implements ariba::overlay::OverlayInterface.

Definition at line 108 of file OneHop.cpp.

References logging_info, OneHopStateInvalid, pendingLinks, and state.

Referenced by ~OneHop().

void ariba::overlay::OneHop::joinOverlay ( const EndpointDescriptor boot = EndpointDescriptor::UNSPECIFIED  )  [protected, virtual]

void ariba::overlay::OneHop::leaveOverlay (  )  [protected, virtual]

const EndpointDescriptor & ariba::overlay::OneHop::resolveNode ( const NodeID node  )  [protected, virtual]

void ariba::overlay::OneHop::routeMessage ( const NodeID destnode,
Message msg 
) [protected, virtual]

OverlayInterface::NodeList ariba::overlay::OneHop::getKnownNodes (  )  const [protected, virtual]

See also:
OverlayInterface.h

Implements ariba::overlay::OverlayInterface.

Definition at line 115 of file OneHop.cpp.

References overlayNodes.

void ariba::overlay::OneHop::onLinkUp ( const LinkID lnk,
const NodeID remote 
) [protected, virtual]

void ariba::overlay::OneHop::onLinkDown ( 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]


Member Data Documentation

Definition at line 111 of file OneHop.h.

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

Definition at line 112 of file OneHop.h.

Referenced by deleteOverlay(), joinOverlay(), leaveOverlay(), onLinkUp(), and onMessage().

Definition at line 113 of file OneHop.h.

Referenced by joinOverlay(), and onLinkUp().


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

Generated on Wed May 27 18:24:06 2009 for Ariba by  doxygen 1.5.6