Changes between Version 30 and Version 31 of Documentation/Tutorial/PingPong

Timestamp:

Apr 28, 2009, 4:25:12 PM (15 years ago)

Author:

huebsch

Comment:

--

Documentation/Tutorial/PingPong

@@ -186 +186 @@
 }}}
 
-''Ariba'' provides several callback functions that may used by services to catch all kinds of events that could be of interest. In this exampe we limit ourselves to the event cases of node joins and node leaves. When a node successfull joines to the SpoVNet instance, ''onNodeJoin'' is triggered nn the initiator's service side. He may then react to this event, exemplary shown in line 80-93, implementing ''onNodeJoin''. In this case, the initiator starts establishing a link to the joined node (line 85), essentially for all kinds of communications via ''Ariba''. We then store the link for further usage (line 88) and prepare a timer which intention is to trigger periodic events. In our case we initialize the timer to be triggered every 2 seconds (line 90), before starting it (line 91).
-
-{{{
-100 void PingPong::onNodeLeave( const NodeID& id, const SpoVNetID& spovnetid ){
-101     RemoteNodes::iterator i = remoteNodes.find( id );
-102     if( i != remoteNodes.end() ) remoteNodes.erase( i );
-103 }
-}}}
-
-Node leaves in our case only lead to deletion of links we had stored before, for we don't need them anymore (line 102).
-
-So far, the node is up and running, created or joined a SpoVNet instance. The initiaor started a timer as soon as another node had joined. Now we see what happens when the timer is triggered.
-
-
-{{{
-110 void PingPong::eventFunction(){
-111
-112     logging_info( "pinging our remote nodes" );
-113
-114     RemoteNodes::iterator i = remoteNodes.begin();
-115     RemoteNodes::iterator iend = remoteNodes.end();
-116
-117     pingid++;
-118
-119     for( ; i != iend; i++ ){
-120             logging_info( "     -> pinging " << i->first );
-121
-122             PingPongMessage pingmsg( pingid );
-123             overlay->sendMessage( &pingmsg, i->second );
-124     }
-125 }
-}}}
-
-Everytime the timer 'fires', ''eventFunction'' is called on a node (lines 110-125). In this example, the initiator sends a message to every node that has joined up to this point in time. To accomplish this, it iterates through all established links (line 119), builts a message for every link and finally sends the message using the Base Overlay in ''Ariba'' (line 123). Sending messages is done by passing the message object to ''Ariba'', together with the target link to use. . We will now take a short look at how such a message is composed in the ping pong example.
+So far, the node is up and running, created or joined a SpoVNet instance. As very node starts a timer as soon as it has joined, we now inspect what happens when the timer is triggered.
+
+{{{
+01 void PingPong::eventFunction() {
+02
+03      // we ping all nodes that are known in the overlay structure
+04      // this can be all nodes (OneHop) overlay or just some neighbors
+05      // in case of a Chord or Kademlia structure
+06
+07      // in this sample we use auto-links: we just send out our message
+08      // to the node and the link is established automatically. for more
+09      // control we would use the node->establishLink function to create
+10      // a link and start using the link in the CommunicationListener::onLinkUp
+11      // function that is implemented further down in PingPong::onLinkUp
+12
+13      logging_info( "pinging overlay neighbors with ping id " << ++pingId );
+14
+15      PingPongMessage pingmsg( pingId );
+16
+17      //-----------------------------------------------------------------------
+18      // Option 1: get all neighboring nodes and send the message to each
+19      //-----------------------------------------------------------------------
+20      vector<NodeID> nodes = node->getNeighborNodes();
+21      BOOST_FOREACH( NodeID nid, nodes ){
+22              node->sendMessage( pingmsg, nid, PingPong::PINGPONG_SERVICEID );
+23      }
+24
+25      //-----------------------------------------------------------------------
+26      // Option 2: send a "broadcast message" that actually does the same thing
+27      //           internally, gets all neighboring nodes and sends the message
+28      //-----------------------------------------------------------------------
+29      // node->sendBroadcastMessage( pingmsg, PingPong::PINGPONG_SERVICEID );
+30 }
+}}}
+
+Everytime the timer 'fires', ''eventFunction'' is called on a node. In this example, every node sends a message to every node that is part of the network at this point in time. To accomplish this, it iterates through all established links (line 20-23), builts a message for every link and finally sends the message using the Base Overlay in ''Ariba'' (line 123). Sending messages is done by passing the message object to ''Ariba'', together with the target link to use. . We will now take a short look at how such a message is composed in the ping pong example.
 
 {{{
@@ -264 +266 @@
 
 Getting back to ''!PingPong.cpp'': After the initiator has send a message to a joiner, it will arrive and has to be handled. This is accomplished in ''receiveMessage'' (the name says it). Every received message has to be decapsulated by a service, casting the data back to the service's message format (line 132). 
+
+''Ariba'' provides several callback functions that may used by services to catch all kinds of events that could be of interest. In this exampe we limit ourselves to the event cases of node joins and node leaves. When a node successfull joines to the SpoVNet instance, ''onNodeJoin'' is triggered nn the initiator's service side. He may then react to this event, exemplary shown in line 80-93, implementing ''onNodeJoin''. In this case, the initiator starts establishing a link to the joined node (line 85), essentially for all kinds of communications via ''Ariba''. We then store the link for further usage (line 88) and prepare a timer which intention is to trigger periodic events. In our case we initialize the timer to be triggered every 2 seconds (line 90), before starting it (line 91).
+
+{{{
+100 void PingPong::onNodeLeave( const NodeID& id, const SpoVNetID& spovnetid ){
+101     RemoteNodes::iterator i = remoteNodes.find( id );
+102     if( i != remoteNodes.end() ) remoteNodes.erase( i );
+103 }
+}}}
+
+Node leaves in our case only lead to deletion of links we had stored before, for we don't need them anymore (line 102).