RubyGems - trimurti - Versions diffs - 0.1 - Mend

trimurti 0.1

Files changed (129) hide show

data/trimurti-0.1/docs/classes/Array.html +176 -0
data/trimurti-0.1/docs/classes/Array.src/M000005.html +19 -0
data/trimurti-0.1/docs/classes/Array.src/M000006.html +19 -0
data/trimurti-0.1/docs/classes/Asserter.html +136 -0
data/trimurti-0.1/docs/classes/Brahma.html +360 -0
data/trimurti-0.1/docs/classes/Brahma.src/M000029.html +21 -0
data/trimurti-0.1/docs/classes/Brahma.src/M000030.html +20 -0
data/trimurti-0.1/docs/classes/Brahma.src/M000031.html +36 -0
data/trimurti-0.1/docs/classes/Brahma.src/M000032.html +18 -0
data/trimurti-0.1/docs/classes/Brahma.src/M000033.html +20 -0
data/trimurti-0.1/docs/classes/Brahma.src/M000034.html +21 -0
data/trimurti-0.1/docs/classes/Brahma.src/M000035.html +25 -0
data/trimurti-0.1/docs/classes/Brahma.src/M000036.html +22 -0
data/trimurti-0.1/docs/classes/Brahma.src/M000037.html +22 -0
data/trimurti-0.1/docs/classes/ComponentSpec.html +275 -0
data/trimurti-0.1/docs/classes/ComponentSpec.src/M000001.html +21 -0
data/trimurti-0.1/docs/classes/ComponentSpec.src/M000002.html +18 -0
data/trimurti-0.1/docs/classes/DRb.html +165 -0
data/trimurti-0.1/docs/classes/DRb.src/M000062.html +18 -0
data/trimurti-0.1/docs/classes/DRb.src/M000063.html +18 -0
data/trimurti-0.1/docs/classes/GUID.html +129 -0
data/trimurti-0.1/docs/classes/Linda.html +444 -0
data/trimurti-0.1/docs/classes/Linda.src/M000007.html +16 -0
data/trimurti-0.1/docs/classes/Linda.src/M000008.html +16 -0
data/trimurti-0.1/docs/classes/Linda.src/M000009.html +20 -0
data/trimurti-0.1/docs/classes/Linda.src/M000010.html +16 -0
data/trimurti-0.1/docs/classes/Linda.src/M000011.html +18 -0
data/trimurti-0.1/docs/classes/Linda.src/M000012.html +21 -0
data/trimurti-0.1/docs/classes/Linda.src/M000013.html +18 -0
data/trimurti-0.1/docs/classes/Linda.src/M000014.html +18 -0
data/trimurti-0.1/docs/classes/Linda.src/M000015.html +18 -0
data/trimurti-0.1/docs/classes/Linda.src/M000016.html +18 -0
data/trimurti-0.1/docs/classes/Linda.src/M000017.html +20 -0
data/trimurti-0.1/docs/classes/Linda.src/M000018.html +20 -0
data/trimurti-0.1/docs/classes/Object.html +153 -0
data/trimurti-0.1/docs/classes/Object.src/M000021.html +18 -0
data/trimurti-0.1/docs/classes/Plugins.html +174 -0
data/trimurti-0.1/docs/classes/Plugins.src/M000024.html +32 -0
data/trimurti-0.1/docs/classes/Plugins.src/M000025.html +32 -0
data/trimurti-0.1/docs/classes/Plugins/Spec.html +267 -0
data/trimurti-0.1/docs/classes/Plugins/Spec.src/M000026.html +22 -0
data/trimurti-0.1/docs/classes/Plugins/Spec.src/M000027.html +18 -0
data/trimurti-0.1/docs/classes/Plugins/Spec.src/M000028.html +20 -0
data/trimurti-0.1/docs/classes/QBE_ID.html +147 -0
data/trimurti-0.1/docs/classes/QBE_ID.src/M000059.html +18 -0
data/trimurti-0.1/docs/classes/QueryByExample.html +270 -0
data/trimurti-0.1/docs/classes/QueryByExample.src/M000054.html +17 -0
data/trimurti-0.1/docs/classes/QueryByExample.src/M000055.html +17 -0
data/trimurti-0.1/docs/classes/QueryByExample.src/M000056.html +17 -0
data/trimurti-0.1/docs/classes/QueryByExample.src/M000057.html +17 -0
data/trimurti-0.1/docs/classes/QueryByExample.src/M000058.html +17 -0
data/trimurti-0.1/docs/classes/Shiva.html +159 -0
data/trimurti-0.1/docs/classes/Shiva.src/M000060.html +18 -0
data/trimurti-0.1/docs/classes/Shiva.src/M000061.html +19 -0
data/trimurti-0.1/docs/classes/String.html +176 -0
data/trimurti-0.1/docs/classes/String.src/M000022.html +16 -0
data/trimurti-0.1/docs/classes/String.src/M000023.html +16 -0
data/trimurti-0.1/docs/classes/Symbol.html +176 -0
data/trimurti-0.1/docs/classes/Symbol.src/M000003.html +16 -0
data/trimurti-0.1/docs/classes/Symbol.src/M000004.html +16 -0
data/trimurti-0.1/docs/classes/Trimurti.html +189 -0
data/trimurti-0.1/docs/classes/Trimurti.src/M000019.html +16 -0
data/trimurti-0.1/docs/classes/Trimurti.src/M000020.html +16 -0
data/trimurti-0.1/docs/classes/Vishnu.html +563 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000038.html +18 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000039.html +18 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000040.html +18 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000041.html +22 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000042.html +23 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000043.html +24 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000044.html +24 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000045.html +18 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000046.html +22 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000047.html +20 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000048.html +18 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000049.html +22 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000050.html +20 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000051.html +19 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000052.html +30 -0
data/trimurti-0.1/docs/classes/Vishnu.src/M000053.html +21 -0
data/trimurti-0.1/docs/created.rid +1 -0
data/trimurti-0.1/docs/dot/f_0.dot +14 -0
data/trimurti-0.1/docs/dot/f_0.png +0 -0
data/trimurti-0.1/docs/dot/f_1.dot +14 -0
data/trimurti-0.1/docs/dot/f_1.png +0 -0
data/trimurti-0.1/docs/dot/f_2.dot +14 -0
data/trimurti-0.1/docs/dot/f_2.png +0 -0
data/trimurti-0.1/docs/dot/f_3.dot +39 -0
data/trimurti-0.1/docs/dot/f_3.png +0 -0
data/trimurti-0.1/docs/dot/f_4.dot +39 -0
data/trimurti-0.1/docs/dot/f_4.png +0 -0
data/trimurti-0.1/docs/dot/f_5.dot +69 -0
data/trimurti-0.1/docs/dot/f_5.png +0 -0
data/trimurti-0.1/docs/dot/f_6.dot +149 -0
data/trimurti-0.1/docs/dot/f_6.png +0 -0
data/trimurti-0.1/docs/dot/m_3_0.dot +30 -0
data/trimurti-0.1/docs/dot/m_3_0.png +0 -0
data/trimurti-0.1/docs/dot/m_4_0.dot +39 -0
data/trimurti-0.1/docs/dot/m_4_0.png +0 -0
data/trimurti-0.1/docs/dot/m_5_0.dot +40 -0
data/trimurti-0.1/docs/dot/m_5_0.png +0 -0
data/trimurti-0.1/docs/dot/m_5_1.dot +30 -0
data/trimurti-0.1/docs/dot/m_5_1.png +0 -0
data/trimurti-0.1/docs/dot/m_6_0.dot +40 -0
data/trimurti-0.1/docs/dot/m_6_0.png +0 -0
data/trimurti-0.1/docs/dot/m_6_1.dot +30 -0
data/trimurti-0.1/docs/dot/m_6_1.png +0 -0
data/trimurti-0.1/docs/dot/m_6_2.dot +30 -0
data/trimurti-0.1/docs/dot/m_6_2.png +0 -0
data/trimurti-0.1/docs/files/License_txt.html +132 -0
data/trimurti-0.1/docs/files/ReadMe_Amber_txt.html +491 -0
data/trimurti-0.1/docs/files/ReadMe_txt.html +694 -0
data/trimurti-0.1/docs/files/nist/trimurti/linda_rb.html +129 -0
data/trimurti-0.1/docs/files/nist/trimurti/plugins_rb.html +129 -0
data/trimurti-0.1/docs/files/nist/trimurti/queryByExample_rb.html +128 -0
data/trimurti-0.1/docs/files/nist/trimurti/trimurti_rb.html +151 -0
data/trimurti-0.1/docs/fr_class_index.html +43 -0
data/trimurti-0.1/docs/fr_file_index.html +33 -0
data/trimurti-0.1/docs/fr_method_index.html +89 -0
data/trimurti-0.1/docs/images/overview.jpg +0 -0
data/trimurti-0.1/docs/index.html +24 -0
data/trimurti-0.1/docs/rdoc-style.css +208 -0
data/trimurti-0.1/lib/nist/trimurti/linda.rb +163 -0
data/trimurti-0.1/lib/nist/trimurti/plugins.rb +107 -0
data/trimurti-0.1/lib/nist/trimurti/queryByExample.rb +81 -0
data/trimurti-0.1/lib/nist/trimurti/trimurti.rb +433 -0
data/trimurti-0.1/tests/test_linda.rb +111 -0
data/trimurti-0.1/tests/test_trimurti.rb +247 -0
metadata +241 -0

data/trimurti-0.1/docs/files/ReadMe_txt.html ADDED Viewed

@@ -0,0 +1,694 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: ReadMe.txt</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>ReadMe.txt</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>ReadMe.txt
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sun Jan 15 15:10:20 EST 2006</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="diagram">
+      <map id="map" name="map">
+</map>
+<img src="../dot/f_1.png" usemap="#map" border=0 alt="TopLevel">
+    </div>
+    <div id="description">
+      <h2>Overview</h2>
+<p>
+<a href="../classes/Trimurti.html">Trimurti</a> simplifies the assembly of
+modularized applications.
+</p>
+<p>
+Included is code to:
+</p>
+<ul>
+<li>Search for plugin code resident on the host running the application
+</li>
+<li>Load plugins
+</li>
+<li>Keep track of local and distributed components and services
+</li>
+<li>Connect consumers to local and distributed services
+</li>
+<li>Configure the relationships between service consumers and providers
+</li>
+<li>Tear down the application when it&#8217;s finished
+</li>
+</ul>
+<p>
+Some of this functionality is known &quot;Dependency Injection&quot;, or
+&quot;Inversion of Control&quot;. These ideas are described at <a
+href="http://www.martinfowler.com/articles/injection.html">www.martinfowler.com/articles/injection.html</a>.
+</p>
+<h3>Analysis Class Model</h3>
+<p>
+<img src="../images/overview.jpg">
+</p>
+<h3>Discsussion of Class Model</h3>
+<p>
+Starting in the lower right corner of the diagram, a Plugin is a File
+containing arbitrary Code and/or Components. If the application loads the
+plugins after all other code has been required, the plugins can add
+functionality to any class in the application.
+</p>
+<p>
+Components are Objects that provide one or more Services to other Objects
+in the system. A Service is an API designated by a <a
+href="../classes/Symbol.html">Symbol</a>. Depending on the configuration
+(which will be discussed momentarily), Components may either
+</p>
+<ul>
+<li>Require services provided by any any object that implements the designated
+API,
+</li>
+<li>Require services provided by some specific Component (identified by name).
+</li>
+</ul>
+<p>
+Components can be assembled automatically by an instance of any class that
+mixes in <a href="../classes/Brahma.html">Brahma</a>. To participate in
+automatic assembly, Components need to be registered with the assembler.
+You can mix <a href="../classes/Brahma.html">Brahma</a> into your own
+class, or use <a href="../classes/Trimurti.html">Trimurti</a>. If you use
+<a href="../classes/Trimurti.html">Trimurti</a>, You can either create one
+or more instances of <a href="../classes/Trimurti.html">Trimurti</a> (being
+aware that they will have different registries), or you can send messages
+to the class (they will be redirected to a default instance). The rdocs do
+not show these redirected messages, because they are metacoded (which is
+invisible to rdoc).
+</p>
+<p>
+There are two ways to register components:
+</p>
+<ul>
+<li>register_component can be called from a &#8216;require&#8217;d file, such
+as a plugin. This method allow the loosest coupling, since no configuration
+file is required.
+</li>
+<li>application setup code can use <a
+href="../classes/Brahma.html#M000035">Brahma#from_yaml</a> to parse a YAML
+file that contains marshalled ComponentSpecs.
+</li>
+</ul>
+<p>
+Once all the Components have been registered, the <a
+href="../classes/Brahma.html#M000033">Brahma#assemble</a> method perfoms
+the assembly.
+</p>
+<p>
+To assemble the Components into larger structures, Brama calls setters. The
+registration information must include a setter method name for every
+Service that a Component requires.
+</p>
+<p>
+Components can also have code snippets for each of several life cyle
+events. Although the application can specify additional life cycle events,
+the standard selectors are:
+</p>
+<ul>
+<li>:create - Instantiate the component
+</li>
+<li>:start - Activate the component&#8217;s services
+</li>
+<li>:stop - Turn off the component&#8217;s services
+</li>
+<li>:destroy - Discard references to other components
+</li>
+</ul>
+<p>
+These code snippets are Strings that are executed in the context of the
+object that performs the assembly. To execute behaviors in the Component,
+send messages to the &#8216;component&#8217; local variable:
+</p>
+<pre>
+    {:start =&gt; 'component.do_startup_stuff'}
+</pre>
+<p>
+Notice that the &#8216;component&#8217; local variable is nil during
+:create snippet execution. All of the life cycle snippets are optional,
+except for :create, which is required
+</p>
+<ul>
+<li>when registration is through marshalled ComponentSpecs
+</li>
+<li>when register_component is given a nil component to register.
+</li>
+</ul>
+<p>
+When the application is ready to quit, <a
+href="../classes/Shiva.html#M000061">Shiva#destroy_components</a> can be
+called to invoke any Component optional :stop and/or :destroy life_cycle
+code.
+</p>
+<p>
+If you wish to add your own life_cycle events, you need to call the
+life_cycle method to trigger execution of the specified snippet for all the
+Components that have been registered with with that event. The order is not
+specified. For example, if
+</p>
+<pre>
+    {:lunar_eclipse =&gt; 'component.mysterious_stuff'}
+</pre>
+<p>
+is included in a Component&#8217;s life_cycle Hash, that Component will
+perform its mysterious_stuff behavior when the application invokes
+</p>
+<pre>
+    Trimurti.life_cycle(:lunar_eclipse)
+</pre>
+<p>
+(provided, of course, the default <a
+href="../classes/Trimurti.html">Trimurti</a> instance was used to assemble
+all the Components).
+</p>
+<h2>Status</h2>
+<p>
+<a href="../classes/Trimurti.html">Trimurti</a> is currently pre-release
+software, which has not yet undergone internal reviews. <a
+href="../classes/Trimurti.html">Trimurti</a> is actively being used on the
+large Focus project to build an augmented reality UML modeling tool.
+</p>
+<h2>Installation</h2>
+<p>
+<a href="../classes/Trimurti.html">Trimurti</a> can be downloaded in
+several forms:
+</p>
+<ul>
+<li>A RubyGem, containing only <a href="../classes/Trimurti.html">Trimurti</a>.
+Due to lack of resources, the RubyGem is untested.
+</li>
+<li>A development snapshot containing <a
+href="../classes/Trimurti.html">Trimurti</a> and nearly everything it
+depends on, in a .tgz or .zip archive. The shapshot contains a complete
+Amber development environment. Before using the development snapshot, you
+need to:
+<ol>
+<li>Setup Amber (included in the snapshot): see <a
+href="ReadMe_Amber_txt.html">ReadMe_Amber.txt</a>
+</li>
+<li>Install libraries required by <a
+href="../classes/Trimurti.html">Trimurti</a>:
+<pre>
+    cd $DevRoot/Projects/trimurti
+    rake install_lib
+</pre>
+</li>
+</ol>
+</li>
+</ul>
+<h2><a href="../classes/Plugins.html">Plugins</a></h2>
+<p>
+<a href="../classes/Plugins.html">Plugins</a> are files that can be loaded
+by Ruby&#8217;s &quot;require&quot; method. <a
+href="../classes/Plugins.html">Plugins</a> reside on the
+application&#8217;s host: they may or may not offer or use components or
+services.
+</p>
+<p>
+Plugin handling code can be mixed into any class. There are several ways
+applications can use this code. In every case the application loads plugins
+via require_plugins, but there are different ways to integrate the plugin
+into the application. The plugin needs to know which integration methods
+are supported by the application.
+</p>
+<p>
+Integration of the plugins into the application may require:
+</p>
+<ul>
+<li>Initializing any data structures required by the plugin
+</li>
+<li>Adding the plugin&#8217;s functionality to the application&#8217;s menus
+</li>
+<li>Adding a description of the Plugin to the appliction&#8217;s
+&quot;About&#8230;&quot; dialog.
+</li>
+</ul>
+<p>
+The following methods can be used to integrate plugins:
+</p>
+<ul>
+<li>The plugin code can add a <a
+href="../classes/Plugins/Spec.html">Plugins::Spec</a> object to $PLUGINS.
+The application can then use this information to integrate the plugins (see
+the upcoming example)
+</li>
+<li>The application can supply a block to require_plugins, which takes as an
+argument the plugin file&#8217;s local path (with file name but without
+extension). This block is executed after the plugin is loaded. The block
+can invoke application-required plugin-specific integration code which is
+defined in the plugin itself.
+</li>
+<li>The plugin can add methods to the application, and change methods in the
+application, so that it behaves differently.
+</li>
+<li><a href="../classes/Plugins.html">Plugins</a> can contain components and
+services which can be hooked up automatically by <a
+href="../classes/Brahma.html">Brahma</a>.
+</li>
+</ul>
+<h2>Using plugins (presuming integration via $PLUGINS)</h2>
+<h3>Application code</h3>
+<pre>
+  require 'nist/trimurti/plugins'
+  class SomeApplication
+  include 'Plugins'
+  def run
+    require_plugins('some/path/*.rb')
+    $PLUGINS.each {|plugin_spec|
+        plugin_spec.init(self)
+        next unless app_has_gui
+        # Add here: your code that integrates plugin_spec.actions into GUI.
+        #           The following example plugin code presumes menus call Procs.
+        # Add here: your code that adds plugin_spec.to_s into the &quot;About...&quot; dialog
+        }
+     # Add here: your non-plugin runtime behavior
+  end
+  SomeApplication.new.run
+</pre>
+<h3>Plugin code</h3>
+<pre>
+  class SomeApplication
+  def fly
+    # some code
+  end
+  def crash_land
+    # more code
+  end
+  def fuelup
+    # initialize flying capability
+  end
+  end
+  # Adds 'PixieDust' functionality to SomeApplication. The author is 'Wile E. Coyote'
+  spec = Plugins::Spec.new('PixieDust', 'Wile E. Coyote', 'Makes application fly')
+  spec.init_proc = lamba {|app| app.fuelup }
+  spec.actions = { 'Fly' =&gt; lambda {|app| app.fly}, 'Crash' =&gt; lambda {|app| app.crash_land} }
+  $PLUGINS &lt;&lt; spec
+  # We are presuming that SomeApplication (in it's startup code)
+  # 1. Requires the plugin code
+  # 2. Iterates over $PLUGINS, to add 'Fly' and 'Crash' menu items to a Plugin menu.
+</pre>
+<h2><a href="../classes/Linda.html">Linda</a></h2>
+<p>
+<a href="../classes/Linda.html">Linda</a> is a wrapper on Rinda that makes
+it look a bit more like the <a href="../classes/Linda.html">Linda</a>
+described by Carriero and Gelernter, and that makes it easier to switch
+between local and distributed Tuple spaces. Unlike Rinda, <a
+href="../classes/Linda.html">Linda</a> Tuples do not expire. <a
+href="../classes/Linda.html">Linda</a> does not yet accomodate
+&#8216;live&#8217; (in Gelernter&#8217;s sense, meaning
+&#8216;executing&#8217;) Tuples (which are not part of Rinda). You do not
+need to understand or use <a href="../classes/Linda.html">Linda</a> in
+order to use plugins, components, or services, but it&#8217;s available if
+you want it.
+</p>
+<h2>Using <a href="../classes/Linda.html">Linda</a></h2>
+<pre>
+  require 'nist/trimurti/linda'
+  # Insert some Tuples in Tuplespace
+  Linda.put(:superhero, 'Flaming Carrot', 'Zen Stupidity')
+  Linda.put(:superhero, 'The Spleen', 'Flatulence')
+  Linda.put(:vegetable, 'Carrot', 'Beta carotene')
+  # Prints &quot;[:vegetable, 'Carrot', 'Beta carotene']&quot; (rdp reads Tuple: if no match, it returns nil)
+  print &quot;\n#{Linda.rdp(:vegetable, /Carrot/, nil).inspect}&quot;
+  # Prints 'nil'
+  print &quot;\n#{Linda.rdp(:vegetable, /Wombat/, nil).inspect}&quot;
+  # Prints &quot;[ [:superhero, 'Flaming Carrot', 'Zen Stupidity'], [:vegetable, 'Carrot', 'Beta carotene'] ]&quot;
+  print &quot;\n#{Linda.rd_all(nil, /Carrot/, nil).inspect}&quot;
+  # Prints '[]'
+  print &quot;\n#{Linda.rd_all(nil, /Wombat/, nil).inspect}&quot;
+  # Prints &quot;[:superhero, 'Flaming Carrot', 'Zen Stupidity']&quot; (removes Tuple: if no match, sleeps until one is available)
+  print &quot;\n#{Linda.get(:superhero, /Carrot/, nil).inspect}&quot;
+  # Prints 'nil' (because we removed the tuple)
+  print &quot;\n#{Linda.rdp(:superhero, /Carrot/, nil).inspect}&quot;
+</pre>
+<h2>Components and Services</h2>
+<p>
+A service is a coherent collection of behaviors offered by a local or
+remote object. A component is an object that consumes and/or offers one or
+more services. Components are typically loaded via require_plugins.
+</p>
+<p>
+Several modules are available for managing components and services:
+</p>
+<ul>
+<li><a href="../classes/Vishnu.html">Vishnu</a> uses <a
+href="../classes/Linda.html">Linda</a> to preserve registries of Components
+and Services.
+</li>
+<li><a href="../classes/Brahma.html">Brahma</a> uses the component and service
+registries to create applications by automatically interconnecting
+components and services.
+</li>
+<li><a href="../classes/Shiva.html">Shiva</a> uses the component registry to
+shutdown and destroy applications in an orderly fashion.
+</li>
+</ul>
+<p>
+<a href="../classes/Trimurti.html">Trimurti</a> is a class that includes
+all the plugin, component, and service managment functionality.
+</p>
+<p>
+Tuples in the component registry look like this:
+</p>
+<pre>
+      [:component, name, component, hostname, provides, needs, life_cycle]
+</pre>
+<ol>
+<li>:component is a literal, shared by all components.
+</li>
+<li>&#8216;name&#8217; is a <a href="../classes/String.html">String</a> which
+uniqely identifies the component
+</li>
+<li>&#8216;component&#8217; is the object providing the service (or a DRB
+proxy)
+</li>
+<li>&#8216;hostname&#8217; is <a href="../classes/String.html">String</a> that
+identifies the computer providing the component
+</li>
+<li>&#8216;provides&#8217; is an <a href="../classes/Array.html">Array</a> of
+Symbols: each is the name of a service API served up by the component.
+Typically the API is a module, but it does not have to be: it can just be a
+symbolic name for a collection of methods.
+</li>
+<li>&#8216;needs&#8217; is a Hash that describes how to provide necessary
+services to the component:
+<ul>
+<li>Key is a name of a method (on the component) that takes one argument (the
+service provider)
+</li>
+<li>Value is either:
+<ul>
+<li>a <a href="../classes/Symbol.html">Symbol</a> that identifies the required
+API
+</li>
+<li>an <a href="../classes/Array.html">Array</a> containing the 3 arguments to
+:service
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>&#8216;life_cycle&#8217; is a Hash the describes how to manage the
+component:
+<ul>
+<li>Keys are Symbols that specify life cycle events. The following keys are
+valid:
+<ul>
+<li>:create - Instantiate the component
+</li>
+<li>:start - Activate all services (called after connection to other services)
+</li>
+<li>:stop - Turn off all services (called before destruction)
+</li>
+<li>:destroy - Discard references to other components
+</li>
+</ul>
+</li>
+<li>Values are code Strings that specify behaviors that is to occur at life
+cyle events.
+</li>
+</ul>
+</li>
+</ol>
+<p>
+Tuples in the service registry look like this:
+</p>
+<pre>
+      [:service, name, component, hostname, symbol]
+</pre>
+<ol>
+<li>:service is a literal, shared by all services.
+</li>
+<li>&#8216;name&#8217; is a <a href="../classes/String.html">String</a> which
+uniqely identifies the component providing the service
+</li>
+<li>&#8216;component&#8217; is the component object providing the service
+</li>
+<li>&#8216;hostname&#8217; is <a href="../classes/String.html">String</a> that
+identifies the computer providing the service
+</li>
+<li>&#8216;symbol&#8217; specifies the service API served up by the component.
+Of course a given component may offer more than one service API: if it
+does,
+<pre>
+      that component has multiple :service Tuples, one for each service it offers.
+</pre>
+</li>
+</ol>
+<p>
+Service tuples can be generated automatically from the component tuples:
+one component Tuple may correspond to several service Tuples.
+</p>
+<p>
+The application needs to:
+</p>
+<ol>
+<li>Register Components, either via:
+<ul>
+<li>from_yaml (in the application)
+</li>
+<li>register_component (in the plugins)
+</li>
+</ul>
+</li>
+<li>Interconnect the components, via assemble
+</li>
+</ol>
+<h2>Using Components and Services (application expects plugins to register components)</h2>
+<h3>Application code</h3>
+<pre>
+  require 'nist/trimurti/trimurti'
+  class SomeApplication
+  def run
+      Trimurti.require_plugins('my/path/*.rb')
+      # Presumes plugin code registers components.
+      # If plugins do not register components, the
+      # application could use Trimurti.from_yaml to register components
+      Trimurti.assemble
+      # Application specific code
+      # Add here: other runtime behavior
+      #
+      # Once the application is finished:
+      Trimurti.destroy_components
+  end
+  end
+  SomeApplication.new.run
+</pre>
+<h3>Plugin code</h3>
+<pre>
+  class SomeServer
+  include InterfaceX
+  include InterfaceY
+  attr_accessor :trouble
+  def start
+     # listen for requests included in InterfaceX and InterfaceY
+  end
+  end
+  server = SomeServer.new
+  # Presumes another Component in a different plugin implments :Trouble
+  Trimurti.register_component('Wolfgang', server, [:InterfaceX, :InterfaceY], {:trouble= =&gt; :Trouble})
+  server.start
+</pre>
+<h2>Alternatives</h2>
+<p>
+Ruby dependency injection possibilites include:
+</p>
+<ul>
+<li>Needle <a href="http://needle.rubyforge.org">needle.rubyforge.org</a>/
+</li>
+<li>Seep <a href="http://seep.rubyforge.org">seep.rubyforge.org</a>/
+</li>
+<li>Copland <a href="http://copland.rubyforge.org">copland.rubyforge.org</a>/
+</li>
+<li>MinDI <a
+href="http://redshift.sourceforge.net/mindi/doc/index.html">redshift.sourceforge.net/mindi/doc/index.html</a>
+</li>
+<li>Rico <a
+href="http://raa.ruby-lang.org/project/rico">raa.ruby-lang.org/project/rico</a>/
+</li>
+</ul>
+<h2>Room for improvement</h2>
+<ul>
+<li>Some security mechanism should be added for ComponentSpec.life_cycle code
+Strings and Plugins::Spec.init_proc
+</li>
+<li>life_cycle and init_proc could be made to accept the developer&#8217;s
+choice of Procs, Symbols, or Strings for customization.
+</li>
+</ul>
+<p>
+Author: A. Griesser
+</p>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>