Changeset 7535 for source/ariba/CommunicationListener.h

Timestamp:

Feb 5, 2010, 9:08:33 AM (14 years ago)

Author:

Christoph Mayer

Message:

-missing doxygen in interface

File:

• source/ariba/CommunicationListener.h (modified) (2 diffs)

source/ariba/CommunicationListener.h

@@ -61 +61 @@
 
 public:
-        static CommunicationListener DEFAULT;
+        static CommunicationListener DEFAULT; //< default implementation
 
 protected:
 
+        /**
+         * Construct a communication listener
+         */
         CommunicationListener();
+
+        /**
+         * Destruct a communication listener
+         */
         virtual ~CommunicationListener();
 
         // --- link events ---
 
+        /**
+         * Event called when a link goes up
+         * @param lnk The id of the link
+         * @param remote The remote node where the link ends
+         */
         virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
 
+        /**
+         * Event called when a link goes down
+         * @param lnk The id of the link
+         * @param remote The remote node where the link ends
+         */
         virtual void onLinkDown(const LinkID& lnk, const NodeID& remote);
 
+        /**
+         * Event called when a link has changed,
+         * e.g. through mobility
+         * @param lnk The id of the link
+         * @param remote The remote node where the link ends
+         */
         virtual void onLinkChanged(const LinkID& lnk, const NodeID& remote);
 
+        /**
+         * Event called when a link has failed
+         * @param lnk The id of the link
+         * @param remote The remote node where the link ends
+         */
         virtual void onLinkFail(const LinkID& lnk, const NodeID& remote);
 
+        /**
+         * Request from remote node to open up a link
+         * @param remote The remote node that requests the new link
+         */
         virtual bool onLinkRequest(const NodeID& remote);
 
         // --- general receive method ---
 
+        /**
+         * Called when a message is incoming
+         * @param msg The data message that is received
+         * @param remote The remote node that sent the message
+         * @param lnk The link id of the link where the message is received
+         */
         virtual void onMessage(const DataMessage& msg, const NodeID& remote,
                         const LinkID& lnk = LinkID::UNSPECIFIED);
@@ -87 +125 @@
         // --- dht functionality ---
 
+        /**
+         * Called when a key has been resolved in the DHT
+         * @param key The key that was requested
+         * @param value the data items the key was resolved to
+         */
         virtual void onKeyValue( const Data& key, const vector<Data>& value );