[Gzz-commits] storm/doc/pegboard/storm_with_tapestry--hemppah...

[Hermanni Hyytiälä]

CVSROOT:        /cvsroot/storm
Module name:    storm
Branch:         
Changes by:     Hermanni Hyytiälä <address@hidden>      03/07/04 05:52:33

Modified files:
        doc/pegboard/storm_with_tapestry--hemppah: peg.rst 

Log message:
        more notes, including api

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/storm/storm/doc/pegboard/storm_with_tapestry--hemppah/peg.rst.diff?tr1=1.2&tr2=1.3&r1=text&r2=text

Patches:
Index: storm/doc/pegboard/storm_with_tapestry--hemppah/peg.rst
diff -u storm/doc/pegboard/storm_with_tapestry--hemppah/peg.rst:1.2 
storm/doc/pegboard/storm_with_tapestry--hemppah/peg.rst:1.3
--- storm/doc/pegboard/storm_with_tapestry--hemppah/peg.rst:1.2 Thu Jul  3 
07:16:35 2003
+++ storm/doc/pegboard/storm_with_tapestry--hemppah/peg.rst     Fri Jul  4 
05:52:33 2003
@@ -5,8 +5,8 @@
 
 :Authors:  Hermanni Hyytiälä
 :Date-Created: 2003-07-03
-:Last-Modified: $Date: 2003/07/03 11:16:35 $
-:Revision: $Revision: 1.2 $
+:Last-Modified: $Date: 2003/07/04 09:52:33 $
+:Revision: $Revision: 1.3 $
 :Status:   Incomplete
 
 .. :Stakeholders:
@@ -39,6 +39,8 @@
 
 - currently Tapestry_ implements the DOLR abstracion
 - other abstraction can be implemented also (e.g., DHT)
+- efficient way for nodes to communicate across an overlay and effcient object 
+  location
 - objects are *published* with object to location mappings (pointers)
 - differs from DHTs in that always use the closest available object
 - routing table consists of levels of neighbor links 
@@ -77,12 +79,22 @@
 Overview of Tapestry API
 ========================
 
-TapestryPublishMsg ( ObjectGUID )
-TapestryUnpublishMsg ( ObjectGUID )
-TapestryRouteMsg ( NodeGUID )
-TapestryLocateMsg ( ObjectGUID )
+According to the `Tapestry website`_, there are four main API services in
+Tapestry that are used by other applications:
 
-.. descriptions...
+    PublishObject(O_GUID): 
+    publish, or make available, object O on the local node. This call is best 
+    effort, and receives no confirmation.
+  
+    UnpublishObject(O_GUID): 
+    Best-effort attempt to remove location mappings for O.
+  
+    RouteToObject(O_GUID): 
+    Routes message to location of an object with GUID O_GUID
+  
+    RouteToNode(N_ID, Exact): 
+    Route message to node N. "Exact" specifies whether destination ID needs to 
+    be matched exactly to deliver payload. 
 
 
 Using Tapestry API from other applications
@@ -134,7 +146,26 @@
 
 - in this section, we will outline the design which would allow Storm to
   Tapestry's routing services
+  
+  
+  
+- For finding Storm blocks in a Tapestry overlay, we must create:
+
 
+   - BlockIDTag class for Storm blocks' IDs (ostore.tapestry.api.TapestryTag)
+
+   - BlockIDQuery (implements ostore.tapestry.api.TapestryQuery) class is 
+     used in a StormLocateMsg class (and in 
ostore.tapestry.api.TapestryLocateMsg)
+     to find objects identified by a BlockIDTag
+     
+   - StormLocateMsg class (extends ostore.tapestry.api.TapestryLocateMsg)
+ 
+- For interacting Storm's storage model with Tapestry:
+
+   - StormTapestryManager class which
+     - registers Storm to handle Storm-related Tapestry events
+     - dispatches and handles Storm-related Tapestry events
+    
 .. more to come
 
 Changes
@@ -144,3 +175,4 @@
 
 .. _`Tapestry programmer's guide`: 
http://www.cs.berkeley.edu/%7Eravenben/tapestry/html/guide.html
 .. _Tapestry: 
http://www.cs.berkeley.edu/~ravenben/publications/pdf/tapestry_jsac.pdf
+.. _`Tapestry website`: http://www.cs.berkeley.edu/~ravenben/tapestry/