Changeset 12060 for source/ariba/CommunicationListener.h

Timestamp:

Jun 19, 2013, 11:05:49 AM (12 years ago)

Author:

hock@…

Message:

Reintegrate branch: 20130111-hock-message_classes

improvements:

• new message classes (reboost, zero-copy)
• "fast path" for direct links (skip overlay layer)
• link-properties accessible from the application
• SystemQueue can call boost::bind functions
• protlib compatibility removed (32bit overhead saved in every message)
• addressing2
• AddressDiscovery discoveres only addresses on which we're actually listening
• ariba serialization usage reduced (sill used in OverlayMsg)
• Node::connect, easier and cleaner interface to start-up ariba from the application
• ariba configs via JSON, XML, etc (boost::property_tree)
• keep-alive overhead greatly reduced
• (relayed) overlay links can actually be closed now
• lost messages are detected in most cases
• notification to the application when link is transformed into direct-link
• overlay routing: send message to second best hop if it would be dropped otherwise
• SequenceNumbers (only mechanisms, so for: upward compatibility)
• various small fixes

regressions:

• bluetooth is not yet working again
• bootstrap modules deactivated
• liblog4xx is not working (use cout-logging)

This patch brings great performance and stability improvements at cost of backward compatibility.
Also bluetooth and the bootstrap modules have not been ported to the new interfaces, yet.

File:

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

source/ariba/CommunicationListener.h

@@ -44 +44 @@
 #include "LinkProperties.h"
 #include "DataMessage.h"
+#include "ariba/overlay/SequenceNumber.h"
 
 namespace ariba {
+
+typedef ariba::overlay::SequenceNumber SequenceNumber;
 
 // forward decl
 namespace overlay {
         class BaseOverlay;
+        class OverlayMsg;
 }
 
@@ -116 +120 @@
 
         /**
+         * @DEPRECATED
+         * 
          * Called when a message is incoming
          * @param msg The data message that is received
@@ -123 +129 @@
         virtual void onMessage(const DataMessage& msg, const NodeID& remote,
                         const LinkID& lnk = LinkID::UNSPECIFIED);
+
+
+    /**
+     * NOTE: This interface is still unstable and may change in future releases.
+     *   ---> Especially the parameter «overlay_msg» may be replaced or removed.
+     *   
+     * Called when a message is incoming
+     * @param msg A shared buffer with the (serialized) payload
+     * @param remote The remote node that sent the message
+     * @param lnk The link id of the link where the message is received
+     * @param overlay_msg A pointer to the ariba internal Overlay Message
+     */
+    virtual void onMessage(reboost::shared_buffer_t message,
+            const NodeID& remote,
+            const LinkID& lnk,
+            const SequenceNumber& seqnum,
+            const ariba::overlay::OverlayMsg* overlay_msg);
 
         // --- dht functionality ---
@@ -133 +156 @@
         virtual void onKeyValue( const Data& key, const vector<Data>& value );
 
+    // --- ping pong (routed) ---
+    /**
+     * Called when a ping message was received.
+     * 
+     * @param remote Node which sent the ping message
+     * @return bool Allows to send a pong message (default: true)
+     */
+    virtual bool onPing(const NodeID& remote);
+
+    /**
+     * Called when a ping message is lost.
+     * 
+     * NOTE: A ping message could also get lost without notice.
+     * 
+     * @param remote Node to which the ping message was sent
+     */
+    virtual void onPingLost(const NodeID& remote);
+    
+    /**
+     * Called when a pong message was received.
+     * 
+     * @param remote Node which sent the pong message
+     */
+    virtual void onPong(const NodeID& remote);
 };