You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by bl...@apache.org on 2002/09/26 02:46:04 UTC

cvs commit: jakarta-avalon-excalibur/event/src/xdocs thread.xml menu.xml

bloritsch    2002/09/25 17:46:04

  Modified:    event/src/xdocs menu.xml
  Added:       event/src/xdocs thread.xml
  Log:
  Add new page for THread docs
  
  Revision  Changes    Path
  1.5       +2 -2      jakarta-avalon-excalibur/event/src/xdocs/menu.xml
  
  Index: menu.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/event/src/xdocs/menu.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- menu.xml	25 Sep 2002 21:20:38 -0000	1.4
  +++ menu.xml	26 Sep 2002 00:46:04 -0000	1.5
  @@ -14,8 +14,8 @@
         <item href="event.html" name="Event"/>
         <item href="command.html" name="Command"/>
         <item href="mpool.html" name="MPool"/>
  - <!--     <item href="thread.html" name="Thread"/>
  -      <item href="util.html" name="Util"/>    -->
  +      <item href="thread.html" name="Thread"/>
  +<!--      <item href="util.html" name="Util"/>    -->
       </menu>
   <!--
       <menu name="How To">
  
  
  
  1.1                  jakarta-avalon-excalibur/event/src/xdocs/thread.xml
  
  Index: thread.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
    <header>
      <title>Excalibur Event - Thread</title>
      <authors>
        <person name="Berin Loritsch" email="bloritsch@apache.org"/>
      </authors>
    </header>
    <body>
      <s1 title="Why Thread Was Created">
        <p>
          Thread is a temporary fork of the official Excalibur Thread package.
          The main difference is that we use MPool to back the Thread Pool.
          This portion will go away when we can have an official Excalibur
          Thread project without any dependencies on the Pool package.
        </p>
      </s1>
      <s1 title="When To Use Thread">
        <p>
          The short answer at this time is not to use this version of Thread
          for your own development.  It is a <em>temporary</em> fork to get
          the Command Manager in <link href="command.html">Command</link>
          working without an artificial dependency on a separate pooling
          package when we already have one.
        </p>
      </s1>
      <s1 title="Core Concepts">
        <p>
          Thread has two main peices that you use: Thread Pool and Thread
          Control.  The Thread Pool is what you use to execute some work.
          It pools a thread from a pool of threads, and returns a Thread
          Control.  The Thread Control will allow you to "control" the
          pooled thread.
        </p>
        <s2 title="Thread Pool">
          <p>
            The Thread Pool interface is how the Thread Manager in Command
            will execute the Commands.  Most implementations of the Thread
            Pool will block if there are no more threads available.  When
            one of the threads in use are finished, the pool will then execute
            the Command.
          </p>
        </s2>
        <s2 title="Thread Control">
          <p>
            The Thread Control allows you to perform normal Thread manipulations
            without the Thread Pool losing real control over its collection
            of Threads.  The commands that can be used are join(), interrupt(),
            isFinished(), and getThrowable().
          </p>
        </s2>
      </s1>
    </body>
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2002/09/26 00:46:04 $
      </legal>
    </footer>
  </document>
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>