Changeset 3690 for source/ariba/overlay/modules/onehop/OneHop.h

Timestamp:

May 26, 2009, 1:40:23 AM (15 years ago)

Author:

mies

Message:

Merged 20090512-mies-connectors changes r3472:r3689 into trunk.

File:

• source/ariba/overlay/modules/onehop/OneHop.h (modified) (3 diffs)

source/ariba/overlay/modules/onehop/OneHop.h

@@ -1 @@
-// [Licence]
+// [License]
 // The Ariba-Underlay Copyright
 //
@@ -35 +35 @@
 // official policies, either expressed or implied, of the Institute of
 // Telematics.
-// [Licence]
+// [License]
 
 #ifndef _ONE_HOP_H
@@ -42 +42 @@
 #include <map>
 #include "ariba/overlay/modules/OverlayInterface.h"
-#include "ariba/overlay/modules/onehop/messages/OneHopMessage.h"
-#include "ariba/overlay/modules/onehop/messages/NodeListingRequest.h"
-#include "ariba/overlay/modules/onehop/messages/NodeListingReply.h"
 #include "ariba/utility/logging/Logging.h"
 
 using std::map;
-using ariba::overlay::OverlayInterface;
-using ariba::overlay::OneHopMessage;
-using ariba::overlay::NodeListingRequest;
-using ariba::overlay::NodeListingReply;
 
 namespace ariba {
 namespace overlay {
 
-class OneHop : public OverlayInterface {
+class OneHop: public OverlayInterface {
         use_logging_h( OneHop );
 public:
-        OneHop(
-                BaseOverlay& _overlay,
-                const NodeID& _nodeid,
-                OverlayStructureEvents* _eventsReceiver
-        );
+        OneHop(BaseOverlay& _overlay, const NodeID& _nodeid,
+                        OverlayStructureEvents* _eventsReceiver);
 
         virtual ~OneHop();
 
 protected:
+        /// @see OverlayInterface.h
+        virtual void createOverlay();
 
-        //
-        // OverlayInterface.h
-        //
-
-        virtual void createOverlay();
+        /// @see OverlayInterface.h
         virtual void deleteOverlay();
 
-        virtual void joinOverlay(const EndpointDescriptor& bootstrapEp = EndpointDescriptor::UNSPECIFIED);
+        /// @see OverlayInterface.h
+        virtual void joinOverlay(const EndpointDescriptor& boot =
+                        EndpointDescriptor::UNSPECIFIED);
+
+        /// @see OverlayInterface.h
         virtual void leaveOverlay();
 
-        virtual const EndpointDescriptor& resolveNode( const NodeID& node );
-        virtual void routeMessage( const NodeID& destnode, Message* msg );
+        /// @see OverlayInterface.h
+        virtual const EndpointDescriptor& resolveNode(const NodeID& node);
 
+        /// @see OverlayInterface.h
+        virtual void routeMessage(const NodeID& destnode, Message* msg);
+
+        /// @see OverlayInterface.h
         virtual NodeList getKnownNodes() const;
 
-        //
-        // see CommunicationListener.h or OverlayInterface.h
-        //
+        /// @see CommunicationListener.h or @see OverlayInterface.h
+        virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
 
-        virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
+        /// @see CommunicationListener.h or @see OverlayInterface.h
         virtual void onLinkDown(const LinkID& lnk, const NodeID& remote);
-        virtual void onMessage(const DataMessage& msg, const NodeID& remote, const LinkID& lnk = LinkID::UNSPECIFIED);
+
+        /// @see CommunicationListener.h or @see OverlayInterface.h
+        virtual void onMessage(const DataMessage& msg, const NodeID& remote,
+                        const LinkID& lnk = LinkID::UNSPECIFIED);
 
 private:
-
-        /**
-         * The other nodes in the overlay
-         */
-        typedef map<const NodeID,const LinkID> OverlayNodeMapping;
+        /// The other nodes in the overlay
+        typedef map<const NodeID, const LinkID> OverlayNodeMapping;
         OverlayNodeMapping overlayNodes;
 
-        /**
-         * The current state of the overlay
-         */
+        /// The current state of the overlay
         typedef enum _OneHopState {
-                OneHopStateInvalid                = 0,
-                OneHopStateJoinInitiated          = 1,
-                OneHopStateJoinListingRequested   = 2,
-                OneHopStateCompleted              = 3,
+                OneHopStateInvalid = 0,
+                OneHopStateJoinInitiated = 1,
+                OneHopStateJoinListingRequested = 2,
+                OneHopStateCompleted = 3,
         } OneHopState;
 
         OneHopState state;
-
         uint16_t pendingLinks;
         LinkID bootstrapLink;
-
 };