leosimons 2003/02/20 06:25:23
Modified: event build.xml
event/src/xdocs command-howto.xml command.xml
cpuparser-howto.xml event-howto.xml event.xml
index.xml mpool-howto.xml mpool.xml util-howto.xml
util.xml
Added: event/src/xdocs book.xml tabs.xml
Removed: event/src/xdocs menu.xml
Log:
forrestize
Revision Changes Path
1.44 +1 -1 avalon-excalibur/event/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/build.xml,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -r1.43 -r1.44
--- build.xml 11 Feb 2003 04:40:26 -0000 1.43
+++ build.xml 20 Feb 2003 14:25:20 -0000 1.44
@@ -361,7 +361,7 @@
<target name="docs" depends="setup-filters" description="Generates the
Docs">
<mkdir dir="${docs.dir}"/>
- <ant antfile="${basedir}/../cocoonbuild.xml"/>
+ <ant antfile="${basedir}/../forrestbuild.xml"/>
<copy todir="${docs.dir}">
<fileset dir="${build.docs}">
1.4 +5 -5 avalon-excalibur/event/src/xdocs/command-howto.xml
Index: command-howto.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/src/xdocs/command-howto.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- command-howto.xml 23 Oct 2002 13:50:00 -0000 1.3
+++ command-howto.xml 20 Feb 2003 14:25:21 -0000 1.4
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="Setting Up The Command Manager">
+ <section><title>Setting Up The Command Manager</title>
<p>
Using Command is a two step process. You have to set it up,
and then you can send Commands to it. Because Command uses
@@ -75,8 +75,8 @@
threadManager.register( commandManager );
]]>
</source>
- </s1>
- <s1 title="Running Commands">
+ </section>
+ <section><title>Running Commands</title>
<p>
There are three Command interfaces: Command, DelayedCommand, and
RepeatedCommand.
Each one of those has a special purpose. The Command interface
exposes the method
@@ -171,7 +171,7 @@
}
]]>
</source>
- </s1>
+ </section>
</body>
<footer>
<legal>
1.3 +13 -13 avalon-excalibur/event/src/xdocs/command.xml
Index: command.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/src/xdocs/command.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- command.xml 23 Oct 2002 13:50:00 -0000 1.2
+++ command.xml 20 Feb 2003 14:25:21 -0000 1.3
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="Why Command Was Created">
+ <section><title>Why Command Was Created</title>
<p>
Command was created as a way to offload management functions
to a CommandManager which would execute the functions in the
@@ -20,8 +20,8 @@
to execute. The critical path is the part of your code that
actually solves your problems as opposed to managing resources.
</p>
- </s1>
- <s1 title="When To Use Command">
+ </section>
+ <section><title>When To Use Command</title>
<p>
A better question might be "when should I not to use Command?".
The complexity of the thread management and command timing is
@@ -32,8 +32,8 @@
the old fashioned way. If you do expect your application to
work under heavy load, you will find Command to be indespensible.
</p>
- </s1>
- <s1 title="Core Concepts">
+ </section>
+ <section><title>Core Concepts</title>
<p>
Command is built on top of <link href="event.html">Event</link>.
That means we use a Command Sink to enqueue Commands for the
@@ -42,7 +42,7 @@
a repeating command, so CommandManager will automatically requeue
that command for you.
</p>
- <s2 title="Command">
+ <section><title>Command</title>
<p>
A Command is an object that performs any function you desire.
You create it by simply implementing the Command interface.
@@ -52,24 +52,24 @@
repeated command that is executed again and again until the
Command Manager is shut down.
</p>
- </s2>
- <s2 title="Command Manager">
+ </section>
+ <section><title>Command Manager</title>
<p>
The Command Manager takes care of processing both Commands
and Signals. With Signals, it will notify the registered
Signal listener. With commands it schedules their execution
in a background thread.
</p>
- </s2>
- <s2 title="Thread Manager">
+ </section>
+ <section><title>Thread Manager</title>
<p>
A Thread Manager takes care of the threading policy for the
Command Manager. It manages the thread pool size, and how
often the Event Pipeline (the path from a Source to an
EventHandler) is checked.
</p>
- </s2>
- </s1>
+ </section>
+ </section>
</body>
<footer>
<legal>
1.3 +6 -6 avalon-excalibur/event/src/xdocs/cpuparser-howto.xml
Index: cpuparser-howto.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/src/xdocs/cpuparser-howto.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- cpuparser-howto.xml 23 Oct 2002 13:50:00 -0000 1.2
+++ cpuparser-howto.xml 20 Feb 2003 14:25:21 -0000 1.3
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="System Util Design">
+ <section><title>System Util Design</title>
<p>
SystemUtil determins which CPUParser it needs by examining
the results from <code>System.getProperty( "os.name" )</code>.
@@ -18,8 +18,8 @@
then the full class name needs to be
<code>org.apache.excalibur.util.system.WindowsXP</code>.
</p>
- </s1>
- <s1 title="Writing a CPUParser">
+ </section>
+ <section><title>Writing a CPUParser</title>
<p>
Writing a CPUParser is not hard. You only need to know
how to name your implementation, and then write the relevant
@@ -100,7 +100,7 @@
]]>
</source>
- </s1>
+ </section>
</body>
<footer>
<legal>
1.5 +9 -9 avalon-excalibur/event/src/xdocs/event-howto.xml
Index: event-howto.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/src/xdocs/event-howto.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- event-howto.xml 23 Oct 2002 13:50:00 -0000 1.4
+++ event-howto.xml 20 Feb 2003 14:25:22 -0000 1.5
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="Event is a Framework for Event Processing">
+ <section><title>Event is a Framework for Event Processing</title>
<p>
The first thing that you should expect is that Event does not
<b>do</b> anything by itself. It defines all the core interfaces
@@ -39,8 +39,8 @@
events can then be processed and sent to one of several Queues in
the system.
</p>
- </s1>
- <s1 title="Pulling Events From a Source">
+ </section>
+ <section><title>Pulling Events From a Source</title>
<p>
We have three options: pull one event at a time, unload all the
events, or pull a number of events at a time. Each of these
@@ -84,8 +84,8 @@
m_mySource.setTimeout( 250 );
]]>
</source>
- </s1>
- <s1 title="Sending Events to a Sink">
+ </section>
+ <section><title>Sending Events to a Sink</title>
<p>
We have several options for enqueuing events into a Sink.
We have transactional enqueuing, lossy enqueuing, and
@@ -182,8 +182,8 @@
}
]]>
</source>
- </s1>
- <s1 title="EventHandlers">
+ </section>
+ <section><title>EventHandlers</title>
<p>
Event Handlers are used in automated event routing systems like
SEDA architectures. Basically, it is a way for your object/component
@@ -214,7 +214,7 @@
}
]]>
</source>
- </s1>
+ </section>
</body>
<footer>
<legal>
1.3 +15 -15 avalon-excalibur/event/src/xdocs/event.xml
Index: event.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/src/xdocs/event.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- event.xml 23 Oct 2002 13:50:00 -0000 1.2
+++ event.xml 20 Feb 2003 14:25:22 -0000 1.3
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="Why Event Was Created">
+ <section><title>Why Event Was Created</title>
<p>
Event was created out of a desire to express the Staged Event
Driven Architecture (SEDA) design in an Avalon way. It has
@@ -18,8 +18,8 @@
server, and cleaned up the API to have Queues operate in a
more transactional way.
</p>
- </s1>
- <s1 title="When To Use Event">
+ </section>
+ <section><title>When To Use Event</title>
<p>
Most of the time, your use of the Event package is only to
interface to other subsystems. For instance, the
@@ -34,15 +34,15 @@
reroute the Queues while the system is running, and not lose
any events.
</p>
- </s1>
- <s1 title="Core Concepts">
+ </section>
+ <section><title>Core Concepts</title>
<p>
An Event Pipeline has a set of Sources and Sinks. A Source
is where you get more events, or the "dequeue" side of an
event Queue. A Sink is where you send events on to the next
stage, or the "enqueue" side of an event Queue.
</p>
- <s2 title="Source">
+ <section><title>Source</title>
<p>
The Source can be blocking or non-blocking. A blocking
Source will stop the current thread from processing until
@@ -50,8 +50,8 @@
will return an empty set of events immediately if there
are no more events.
</p>
- </s2>
- <s2 title="Sink">
+ </section>
+ <section><title>Sink</title>
<p>
The Sink allows you to add events in a variety of ways.
You can simply add them one at a time, or you can add
@@ -62,14 +62,14 @@
but it will not let them pass through until they are officially
committed.
</p>
- </s2>
- <s2 title="Queue">
+ </section>
+ <section><title>Queue</title>
<p>
A Queue is merely the union of a Sink and a Source. A Queue
will manage the throughput of the events from Sink to Source.
</p>
- </s2>
- <s2 title="Signals and Messages">
+ </section>
+ <section><title>Signals and Messages</title>
<p>
Signals and Messages are special events that provide contextual
information. A message will have a string and/or an object
@@ -78,8 +78,8 @@
implementation. A Signal is a control event that the Queue,
and the system react to.
</p>
- </s2>
- </s1>
+ </section>
+ </section>
</body>
<footer>
<legal>
1.7 +3 -3 avalon-excalibur/event/src/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/src/xdocs/index.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- index.xml 30 Sep 2002 20:43:10 -0000 1.6
+++ index.xml 20 Feb 2003 14:25:22 -0000 1.7
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="Introduction">
+ <section><title>Introduction</title>
<p>
This is the Excalibur Event package which includes event queues,
asynchronous command processing, and the interfaces to support
@@ -30,7 +30,7 @@
utilities so that we can programatically determine the number
of processors your hardware has.
</p>
- </s1>
+ </section>
</body>
<footer>
<legal>
1.3 +11 -11 avalon-excalibur/event/src/xdocs/mpool-howto.xml
Index: mpool-howto.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/src/xdocs/mpool-howto.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- mpool-howto.xml 23 Oct 2002 13:50:00 -0000 1.2
+++ mpool-howto.xml 20 Feb 2003 14:25:22 -0000 1.3
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="Setting Up the PoolManager">
+ <section><title>Setting Up the PoolManager</title>
<p>
In order to set up a CommandManager. For those instructions,
follow <link href="command-howto.html">the Command "How To"</link>.
@@ -22,8 +22,8 @@
PoolManager poolManager = new DefaultPoolManager( commandManager );
]]>
</source>
- </s1>
- <s1 title="Creating Your Pool">
+ </section>
+ <section><title>Creating Your Pool</title>
<p>
The PoolManager is responsible for manufacturing managed pools,
and for managing their sizes. All PoolManager managed pools are
@@ -39,7 +39,7 @@
Pool managedPool = poolManager.getManagedPool( objectFactory, initialEntries
);
]]>
</source>
- <s2 title="Writing an ObjectFactory">
+ <section><title>Writing an ObjectFactory</title>
<p>
Writing an Object Factory is not that difficult. You just need to
implement the ObjectFactory interface. Below is an example
@@ -89,8 +89,8 @@
}
]]>
</source>
- </s2>
- <s2 title="Unmanaged Pools">
+ </section>
+ <section><title>Unmanaged Pools</title>
<p>
There are two unmanaged pool types in MPool:
FixedSizePool and BlockingFixedSizePool. They are
@@ -107,9 +107,9 @@
example is a JDBC connection pool because some vendors require
you to pay per connection licensing fees.
</p>
- </s2>
- </s1>
- <s1 title="Using the Pool">
+ </section>
+ </section>
+ <section><title>Using the Pool</title>
<p>
Using the pools are quite simple:
</p>
@@ -161,7 +161,7 @@
}
]]>
</source>
- </s1>
+ </section>
</body>
<footer>
<legal>
1.3 +15 -15 avalon-excalibur/event/src/xdocs/mpool.xml
Index: mpool.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/src/xdocs/mpool.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- mpool.xml 23 Oct 2002 13:50:00 -0000 1.2
+++ mpool.xml 20 Feb 2003 14:25:22 -0000 1.3
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="Why MPool Was Created">
+ <section><title>Why MPool Was Created</title>
<p>
MPool (Managed Pool) was created as an experiment in dynamic
pool management. The theory is that by determining whether to
@@ -28,16 +28,16 @@
stress, we create a new object immediately and in a background
process we add new objects.
</p>
- </s1>
- <s1 title="When To Use MPool">
+ </section>
+ <section><title>When To Use MPool</title>
<p>
Use MPool any time you need a pool without hard limits, and you
expect heavy loads. The pool size is checked periodically, so
we don't incur extra overhead of having to check that while the
pool size grows and shrinks.
</p>
- </s1>
- <s1 title="Core Concepts">
+ </section>
+ <section><title>Core Concepts</title>
<p>
MPool has two pool types: fixed size and variable size. A fixed
size pool is not managed externally. There is a fixed limit to
@@ -46,35 +46,35 @@
be created by the PoolManager, and that manager will manage all
of its pool sizes in the background.
</p>
- <s2 title="Object Factory">
+ <section><title>Object Factory</title>
<p>
An Object Factory is what the pools use to create new objects
or destroy old ones. They are particularly helpful when there
is a complex creation/destruction policy. They are also essential
for ManagablePools.
</p>
- </s2>
- <s2 title="Pool">
+ </section>
+ <section><title>Pool</title>
<p>
The base Pool interface is how the client code interacts with
the pool. You acquire and release pooled objects from the
pool.
</p>
- </s2>
- <s2 title="Managable Pool">
+ </section>
+ <section><title>Managable Pool</title>
<p>
A Managable Pool is a special interface that allows a PoolManager
to register itself with a "magic key" so that the managed pool
only responds to the PoolManager responsible for it.
</p>
- </s2>
- <s2 title="Pool Manager">
+ </section>
+ <section><title>Pool Manager</title>
<p>
The Pool Manager is how you obtain a Managable Pool. It also
takes care of the management functions for that pool.
</p>
- </s2>
- </s1>
+ </section>
+ </section>
</body>
<footer>
<legal>
1.3 +3 -3 avalon-excalibur/event/src/xdocs/util-howto.xml
Index: util-howto.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/src/xdocs/util-howto.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- util-howto.xml 23 Oct 2002 13:50:00 -0000 1.2
+++ util-howto.xml 20 Feb 2003 14:25:22 -0000 1.3
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="Getting the System Info">
+ <section><title>Getting the System Info</title>
<p>
Util has one utility: SystemUtil. SystemUtil is a static
class that performs its magic when the class is loaded.
@@ -34,7 +34,7 @@
uses every available SystemUtil method, and it is taken directly
from the JUnit TestCase for SystemUtil.
</p>
- </s1>
+ </section>
</body>
<footer>
<legal>
1.3 +11 -11 avalon-excalibur/event/src/xdocs/util.xml
Index: util.xml
===================================================================
RCS file: /home/cvs/avalon-excalibur/event/src/xdocs/util.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- util.xml 23 Oct 2002 13:50:00 -0000 1.2
+++ util.xml 20 Feb 2003 14:25:22 -0000 1.3
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="Why Util Was Created">
+ <section><title>Why Util Was Created</title>
<p>
Util was created to enable us to find out how many processors are
on a system programmatically. Unfortunately Sun does not think
@@ -16,8 +16,8 @@
Manager uses this to automatically determine how many background
threads it wants in the backing ThreadPool.
</p>
- </s1>
- <s1 title="When To Use Util">
+ </section>
+ <section><title>When To Use Util</title>
<p>
Usually you won't use this package directly, unless you want to
know how many processors a system has. You might need to add a
@@ -25,21 +25,21 @@
environment variables or the /proc/ filesystem for a platform
that is not currently supported.
</p>
- </s1>
- <s1 title="Core Concepts">
+ </section>
+ <section><title>Core Concepts</title>
<p>
Util has a SystemUtil which will load the correct CPU Parser for your
platform. If there is no maching CPU Parser will assume that there
is
only one processor for your system.
</p>
- <s2 title="System Util">
+ <section><title>System Util</title>
<p>
The System Util will allow you to gather any platform specific
information. Some of the methods are simpler ways of accessing
the System properties, and others are derived from the CPU Parser.
</p>
- </s2>
- <s2 title="CPU Parser">
+ </section>
+ <section><title>CPU Parser</title>
<p>
The CPU Parser will allow you to gather essential information from
your platform. Unfortunately we cannot assume there is only one
@@ -52,8 +52,8 @@
don't currently have access to other machines, we can't support
them
yet.
</p>
- </s2>
- </s1>
+ </section>
+ </section>
</body>
<footer>
<legal>
1.5 +27 -19 avalon-excalibur/event/src/xdocs/book.xml
1.1 avalon-excalibur/event/src/xdocs/tabs.xml
Index: tabs.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab
V1.0//EN" "tab-cocoon-v10.dtd">
<tabs software="Excalibur event"
title="Excalibur event"
copyright="Foo"
xmlns:xlink="http://www.w3.org/1999/xlink";>
<tab label="Avalon Home" href="http://avalon.apache.org/"/>
<tab label="Framework" href="http://avalon.apache.org/framework/"/>
<tab label="Components" href="http://avalon.apache.org/components/"/>
<tab label="Phoenix" href="http://avalon.apache.org/phoenix/"/>
<tab label="SECA" href="http://avalon.apache.org/seca/"/>
<tab label="Apps" href="http://avalon.apache.org/apps/"/>
</tabs>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
