gzz-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: Hermanni Hyytiälä
Subject: [Gzz-commits] storm/doc/pegboard/storm_with_tapestry--hemppah...
Date: Fri, 01 Aug 2003 06:53:52 -0400

CVSROOT:        /cvsroot/storm
Module name:    storm
Branch:         
Changes by:     Hermanni Hyytiälä <address@hidden>      03/08/01 06:53:51

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

Log message:
        reformat

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/storm/storm/doc/pegboard/storm_with_tapestry--hemppah/peg.rst.diff?tr1=1.29&tr2=1.30&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.29 
storm/doc/pegboard/storm_with_tapestry--hemppah/peg.rst:1.30
--- storm/doc/pegboard/storm_with_tapestry--hemppah/peg.rst:1.29        Mon Jul 
28 07:51:33 2003
+++ storm/doc/pegboard/storm_with_tapestry--hemppah/peg.rst     Fri Aug  1 
06:53:51 2003
@@ -5,8 +5,8 @@
 
 :Authors:  Hermanni Hyytiälä
 :Date-Created: 2003-07-03
-:Last-Modified: $Date: 2003/07/28 11:51:33 $
-:Revision: $Revision: 1.29 $
+:Last-Modified: $Date: 2003/08/01 10:53:51 $
+:Revision: $Revision: 1.30 $
 :Status:   Incomplete
 
 .. :Stakeholders:
@@ -193,7 +193,7 @@
      arguments
      
 Custom messages for Tapestry
------------------------
+----------------------------
 
 Again, According to the `Tapestry programmer's guide`_:
 
@@ -211,7 +211,7 @@
 
  
 An event handler class
-------------------
+----------------------
 
 1. Write an event handler class which extends SEDA's existing stages, e.g.,
 
@@ -282,15 +282,15 @@
 Here, we propose a simple StormTapestryManager pseudo code. This is an event
 handler class for Tapestry services. In addition to basic event handling 
 functionality, this class supports Storm block query and insert operations 
-in a Tapestry overlay.
-
+in a Tapestry overlay. ::
+ 
        class StormTapestryManager implements EventHandlerIF {
        
                // Dispatcher which dispatches all items
                // to a target peer. 
                // (Mandatory: Sandstorm requires this)
                method dispatch (QueueElementIF item) {
-                       //try do dispatch an item
+                       // try do dispatch an item
                        try {
                                classifier.dispatch(item);
                        } catch (expection) {
@@ -480,7 +480,7 @@
 ==========
 
 Sandstorm configuration files for Storm
---------------------------------------
+---------------------------------------
 
 According to the `Tapestry programmer's guide`_, we have to have
 three different config files for a Storm peer:
@@ -504,165 +504,162 @@
 
 For more information how a Tapestry network is bootstrapped and stabilized, 
please
 see the `Tapestry programmer's guide`_. Here's an example config file for a 
-dynamic Storm peer as the config file includes the DTClient stage:
+dynamic Storm peer as the config file includes the DTClient stage. ::
 
-- - -
-
-# Example Sandstorm configuration file for Storm/Tapestry.
-#
-# !!! Please notice that the documentation of this file is based
-# on a config file distributed within the Tapestry/SEDA 2.0 release. Some
-# parts of this config file are edited to provide better idea which parts
-# 'Storm specific', mandatory/optional &c  !!!
-#
-# The '#' starts a comment which extends to the end of the line
-# This file uses an XML-like format consisting of nested sections.
-# 
-# Most of the sections of this file are optional. The complete set of
-# options is given here just to document their use, and leaving options 
-# unspecified causes them to use their default values. In general it is
-# a good idea to just use the defaults.
-
-# The outermost section in the file must be called 'sandstorm'.
-<sandstorm>
-
-  # Global options
-  <global>
-
-  # The default thread manager for stages. 
-  # Allowable values are 'TPSTM' (thread-per-stage) and 'TPPTM' 
-  # (thread-per-CPU). 
-  defaultThreadManager TPSTM   
-
-    # Options for TPSTM thread manager
-    <TPSTM>
-    # Enable the thread governor. This resizes the thread pool for each
-    # stage when the stage's incoming event queue reaches its threshold.
-    governor false
-    # The sampling delay (in milliseconds) for the thread governor.
-    governorDelay 2000
-    # The maximum number of threads allocated to each thread pool
-    governorMaxThreads 10
-    </TPSTM>
-
-    # Options for TPPTM thread manager
-    <TPPTM>
-    # The number of CPUs in the system. Eventually this will be
-    # determined automatically.
-    numCpus 1
-    # The maximum number of threads to allocate.
-    # In general this value should be equal to numCpus.
-    maxThreads 1
-    </TPPTM>
-
-    # The Sandstorm profiler is extremely valuable for understanding the 
-    # performance of applications, and for identifiying bottlenecks
-    <profile>
-      # specify whether the Sandstorm system profiler should be enabled.
-      enable false
-
-      # specify the samplying delay(in milliseconds) for the profiler.
-      # Default is 1000 ms.
-      delay 1000
-
-      # specify the filename that the profile will be written to.
-      # default is ./sandstorm-profile.txt
-      filename /tmp/sandstorm-profile.txt
-
-      # specify the graphfilename that the graph profile will be written to.
-      # default is ./sandstorm-graph.txt
-      graphfilename /tmp/sandstorm-graph.txt
-
-      # specify whether the profile should generate a graph of stage
-      # connectivity during runtime.  Default is false.
-      graph false
+       # Example Sandstorm configuration file for Storm/Tapestry.
+       #
+       # !!! Please notice that the documentation of this file is based
+       # on a config file distributed within the Tapestry/SEDA 2.0 release. 
Some
+       # parts of this config file are edited to provide better idea which 
parts
+       # 'Storm specific', mandatory/optional &c  !!!
+       #
+       # The '#' starts a comment which extends to the end of the line
+       # This file uses an XML-like format consisting of nested sections.
+       # 
+       # Most of the sections of this file are optional. The complete set of
+       # options is given here just to document their use, and leaving options 
+       # unspecified causes them to use their default values. In general it is
+       # a good idea to just use the defaults.
+
+       # The outermost section in the file must be called 'sandstorm'.
+       <sandstorm>
+
+       # Global options
+       <global>
+
+       # The default thread manager for stages. 
+       # Allowable values are 'TPSTM' (thread-per-stage) and 'TPPTM' 
+       # (thread-per-CPU). 
+       defaultThreadManager TPSTM   
+
+       # Options for TPSTM thread manager
+       <TPSTM>
+       # Enable the thread governor. This resizes the thread pool for each
+       # stage when the stage's incoming event queue reaches its threshold.
+       governor false
+       # The sampling delay (in milliseconds) for the thread governor.
+       governorDelay 2000
+       # The maximum number of threads allocated to each thread pool
+       governorMaxThreads 10
+       </TPSTM>
+
+       # Options for TPPTM thread manager
+       <TPPTM>
+       # The number of CPUs in the system. Eventually this will be
+       # determined automatically.
+       numCpus 1
+       # The maximum number of threads to allocate.
+       # In general this value should be equal to numCpus.
+       maxThreads 1
+       </TPPTM>
+
+       # The Sandstorm profiler is extremely valuable for understanding the 
+       # performance of applications, and for identifiying bottlenecks
+       <profile>
+       # specify whether the Sandstorm system profiler should be enabled.
+       enable false
+
+       # specify the samplying delay(in milliseconds) for the profiler.
+       # Default is 1000 ms.
+       delay 1000
+
+       # specify the filename that the profile will be written to.
+       # default is ./sandstorm-profile.txt
+       filename /tmp/sandstorm-profile.txt
+
+       # specify the graphfilename that the graph profile will be written to.
+       # default is ./sandstorm-graph.txt
+       graphfilename /tmp/sandstorm-graph.txt
+
+       # specify whether the profile should generate a graph of stage
+       # connectivity during runtime.  Default is false.
+       graph false
       
-      # specify whether the outgoing queue length for sockets should be
-      # included in the profile.  Default value is false.
-      sockets false
+       # specify whether the outgoing queue length for sockets should be
+       # included in the profile.  Default value is false.
+       sockets false
     
-    </profile>
+       </profile>
 
-    <initargs>
-      # Global parameters are defined here, for instance, we could define
-      # my_node_id ip-address:port
-    </initargs>
+       <initargs>
+       # Global parameters are defined here, for instance, we could define
+       # my_node_id ip-address:port
+       </initargs>
 
-  </global>
+       </global>
 
-# Each stage is defined by a <stage> section
+       # Each stage is defined by a <stage> section
 
-  <stages>
+       <stages>
 
-  # The name of the stage as registered with the system. Mandatory.
-  <Network>
+       # The name of the stage as registered with the system. Mandatory.
+       <Network>
 
-  # The fully-qualified classname of the stage's event handler. Mandatory.
-  class ostore.network.Network
+       # The   fully-qualified classname of the stage's event handler. 
Mandatory.
+       class ostore.network.Network
 
-  # The size of the event queue threshold for this stage. Optional.
-  # The default is -1, which indicates an infinite threshold.
-  queueThreshold 1000
+       # The size of the event queue threshold for this stage. Optional.
+       # The default is -1, which indicates an infinite threshold.
+       queueThreshold 1000
 
-    # Initial arguments to pass to the event handler's init() method
-    <initargs>
-    # Some parameters for this stage
-    </initargs>
+       # Initial arguments to pass to the event handler's init() method
+       <initargs>
+       # Some parameters for this stage
+       </initargs>
 
-  </Network>
+       </Network>
 
-  <Router>
-     class ostore.tapestry.impl.Router
-     queueThreshold 1000
-     <initargs>
+       <Router>
+       class ostore.tapestry.impl.Router
+       queueThreshold 1000
+       <initargs>
         # Some parameters for this stage
        dynamic_route dynamic
-     </initargs>
-  </Router>                                                                   
+       </initargs>
+       </Router>                                                               
    
+
+       # The name of the stage as registered with the system. Mandatory.
+       <DTClient>
+       # The fully-qualified classname of the stage's event handler. Mandatory.
+       class ostore.tapestry.impl.DynamicTClient
+
+       # The size of the event queue threshold for this stage. Optional.
+       # The default is -1, which indicates an infinite threshold.
+       queueThreshold 1000
+       # Initial arguments to pass to the event handler's init() method
+       <initargs>
+       # An IP address of a gateway peer which bootsraps us into a Tapestry 
network
+       # This is a mandatory for a dynamic Storm peer
+       gateway ${GatewayID}
+       # This parameter tells Tapestry to threat local routing tables 
dynamically
+       dynamic_route dynamic
+       </initargs>
+       </DTClient>
 
-  # The name of the stage as registered with the system. Mandatory.
-  <DTClient>
-    # The fully-qualified classname of the stage's event handler. Mandatory.
-    class ostore.tapestry.impl.DynamicTClient
-
-    # The size of the event queue threshold for this stage. Optional.
-    # The default is -1, which indicates an infinite threshold.
-    queueThreshold 1000
-    # Initial arguments to pass to the event handler's init() method
-    <initargs>
-    # An IP address of a gateway peer which bootsraps us into a Tapestry 
network
-    # This is a mandatory for a dynamic Storm peer
-    gateway ${GatewayID}
-    # This parameter tells Tapestry to threat local routing tables dynamically
-    dynamic_route dynamic
-    </initargs>
-  </DTClient>
-
-  # This stage is not mandatory
-  # Patchwork stage can be used to monitor neighbor links' conditions &c   
-  <Patchwork>
-    class ostore.network.patchwork.Patchwork
-    <initargs>
-      # list here some arguments which we want to define
-    </initargs>                
-  </Patchwork>
-
-  # The name of the stage as registered with the system. Mandatory.
-  <StormTapestry>
-    class org.nongnu.storm.p2p.tapestry.StormTapestryManager
-    queueThreshold 1000
-
-    # Initial arguments to pass to the event handler's init() method
-    <initargs>
-    # list here some arguments which we want to define
-    </initargs>
+       # This stage is not mandatory
+       # Patchwork stage can be used to monitor neighbor links' conditions &c  
 
+       <Patchwork>
+       class ostore.network.patchwork.Patchwork
+       <initargs>
+       # list here some arguments which we want to define
+       </initargs>             
+       </Patchwork>
+
+       # The name of the stage as registered with the system. Mandatory.
+       <StormTapestry>
+       class org.nongnu.storm.p2p.tapestry.StormTapestryManager
+       queueThreshold 1000
+
+       # Initial arguments to pass to the event handler's init() method
+       <initargs>
+       # list here some arguments which we want to define
+       </initargs>
 
-  </StormTapestry>
-  </stages>
+       </StormTapestry>
+       </stages>
 
-</sandstorm>  # End of the configuration file
+       </sandstorm>  # End of the configuration file
 
-- - -
 
 Also, any parameter's value can be set using a command line arguments. For 
 more information about Sandstorm's config files, please refer to the 
documentation
@@ -671,15 +668,15 @@
 Running Storm with Tapestry
 ---------------------------
 
-To run Tapestry with Storm, we must use the following syntax:
-
-  sandstorm <storm-configfile-name> 
-  
-where `sandstorm` is a script distributed within the Sandstorm package and
-`<storm-configfile-name>` is the Sandstorm configuration file for Storm.
+To run Tapestry with Storm, we must use the following syntax.
 
+       sandstorm <storm-configfile-name>
+   
+where ``sandstorm`` is a script distributed within the Sandstorm package and
+``<storm-configfile-name>`` is the Sandstorm configuration file for Storm.
+       
 Also, we can use Perl scripts to handle more complex usage scenarios. In the
-Tapestry 2.0 release, Perl scripts are used to create `dynamic' configuration
+Tapestry 2.0 release, Perl scripts are used to create dynamic configuration
 scripts for regression tests.    
 
 Changes
@@ -688,9 +685,9 @@
 Eight new classes will be implemented under org.nongnu.storm.p2p.tapestry 
package 
 into the Storm code base, if this PEG document is accepted.  
 
-.. _`Tapestry programmer's guide`: 
http://www.cs.berkeley.edu/%7Eravenben/tapestry/html/guide.html
+.. _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/
+.. _Tapestry website: http://www.cs.berkeley.edu/~ravenben/tapestry/
 .. _SEDA: http://www.eecs.harvard.edu/~mdw/proj/seda
-.. _`DOLR abstraction`: 
http://www.cs.berkeley.edu/~ravenben/publications/pdf/apis.pdf
+.. _DOLR abstraction: 
http://www.cs.berkeley.edu/~ravenben/publications/pdf/apis.pdf
 .. _DHT: http://www.cs.berkeley.edu/~ravenben/publications/pdf/apis.pdf 




reply via email to

[Prev in Thread] Current Thread [Next in Thread]