[jboss-cvs] JBoss Messaging SVN: r4350 - trunk/docs/userguide/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Fri May 30 06:21:51 EDT 2008
Author: ataylor
Date: 2008-05-30 06:21:50 -0400 (Fri, 30 May 2008)
New Revision: 4350
Modified:
trunk/docs/userguide/en/modules/about.xml
trunk/docs/userguide/en/modules/configuration.xml
trunk/docs/userguide/en/modules/installation.xml
trunk/docs/userguide/en/modules/journal.xml
trunk/docs/userguide/en/modules/runningexamples.xml
Log:
document updates
Modified: trunk/docs/userguide/en/modules/about.xml
===================================================================
--- trunk/docs/userguide/en/modules/about.xml 2008-05-29 22:28:20 UTC (rev 4349)
+++ trunk/docs/userguide/en/modules/about.xml 2008-05-30 10:21:50 UTC (rev 4350)
@@ -2,24 +2,33 @@
<chapter id="about">
<title>About JBoss Messaging 2.0.0</title>
<para>JBoss Messaging 2 is the next level of messaging system being developed by JBoss,
- designed to attend very large demanding system and so we really believe JBoss
- Messaging 2 will be the most efficient Messaging System written in Java available
- on the market.</para>
- <para>JBoss Messaging 1.4 has been the default implementation on JBoss Service Integration Platform and JBoss 5 for some time already. </para>
+ designed to attend very large demanding systems with the emphasis on making JBM the most efficient Messaging
+ System written in Java available
+ on the market.
+ </para>
+ <para>JBoss Messaging 1.4 has been the default implementation on JBoss Service Integration Platform and JBoss 5 for
+ some time already.
+ </para>
<para>JBoss Messaging is an integral part of Red Hat's strategy for
- messaging.</para>
+ messaging.
+ </para>
<para>The procedure of installing and configuring JBoss Messaging is detailed in this guide, along with a set of
- runnable examples.</para>
- <para>Please send your suggestions or comments to the <ulink
- url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=238">JBoss
- Messaging user forum</ulink>.</para>
+ runnable examples.
+ </para>
+ <para>Please send your suggestions or comments to the<ulink
+ url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=238">JBoss
+ Messaging user forum</ulink>.
+ </para>
<para>Permanent Team: Tim Fox (Project Lead), Jeff Mesnil (Core Developer),
- Andy Taylor (Core Developer), Clebert Suconic (Core Developer)</para>
+ Andy Taylor (Core Developer), Clebert Suconic (Core Developer)
+ </para>
<para>Contributors: Ovidiu Feodorov (Project Founder), Sergey Koshcheyev,
- Ron Sigal, Madhu Konda, Jay Howell, Tyronne Wickramarathne, Aaron Walker,
- Adrian Brock, Rajdeep Dua, Tom Elrod, Alex Fu, Juha Lindfors, Alexey
- Loubyansky, Luc Texier, Scott Stark, Aslak Knutsen</para>
- <para>Messaging support team: Jay Howell, David Boeren, Mike Clark, Tyronne
- Wickramarathne</para>
+ Ron Sigal, Madhu Konda, Jay Howell, Tyronne Wickramarathne, Aaron Walker,
+ Adrian Brock, Rajdeep Dua, Tom Elrod, Alex Fu, Juha Lindfors, Alexey
+ Loubyansky, Luc Texier, Scott Stark, Aslak Knutsen
+ </para>
+ <para>Messaging support team: Jay Howell, David Boeren, Tyronne
+ Wickramarathne
+ </para>
<para>Other thanks to: Mark Little and Pete Bennett</para>
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/modules/configuration.xml
===================================================================
--- trunk/docs/userguide/en/modules/configuration.xml 2008-05-29 22:28:20 UTC (rev 4349)
+++ trunk/docs/userguide/en/modules/configuration.xml 2008-05-30 10:21:50 UTC (rev 4350)
@@ -86,13 +86,13 @@
TCP -->
<remoting-tcp-send-buffer-size>-1</remoting-tcp-send-buffer-size>
- <!-- The interval to send a ping message to send to the client/server to make
- sure it is still alive.-->
+ <!-- The interval to send a ping message to send to the client/server to make sure
+ it is still alive.-->
<!-- Set to 0 if you want to disable this functionality-->
<remoting-keep-alive-interval>10000</remoting-keep-alive-interval>
- <!-- How long to wait for a returning pong after sending a ping message
- to a client/server.-->
+ <!--How long to wait for a returning pong after sending a ping message to a
+ client/server.-->
<!-- If no pong is received after this time resources are cleaned up-->
<remoting-keep-alive-timeout>5000</remoting-keep-alive-timeout>
@@ -119,18 +119,18 @@
<journal-type>asyncio</journal-type>
- <!-- Does the journal sync to disk on each transaction commit, prepare
- or rollback? -->
+ <!-- Does the journal sync to disk on each transaction commit,
+ prepare or rollback? -->
<journal-sync-transactional>true</journal-sync-transactional>
- <!-- Does the journal sync to disk for every non transactional persistent
- operation? -->
+ <!-- Does the journal sync to disk for every non transactional
+ persistent operation? -->
<journal-sync-non-transactional>false</journal-sync-non-transactional>
<journal-file-size>10485760</journal-file-size>
<journal-min-files>10</journal-min-files>
-
+
<!-- Maximum simultaneous asynchronous writes accepted by the native layer.
(parameter ignored on NIO) -->
<journal-max-aio>9000</journal-max-aio>
@@ -733,7 +733,7 @@
<para>The naming Service</para>
<para>This is only found in the standalone version of the beans file. When running within the App Server
this
- is not needed since it is available as its own service. This also where you can change the ports used.
+ is not needed since it is available as its own service. This is also where you can change the ports used.
</para>
<para>It is possible to replace this with any Naming Service however only the JBoss naming provider has been
tested.
Modified: trunk/docs/userguide/en/modules/installation.xml
===================================================================
--- trunk/docs/userguide/en/modules/installation.xml 2008-05-29 22:28:20 UTC (rev 4349)
+++ trunk/docs/userguide/en/modules/installation.xml 2008-05-30 10:21:50 UTC (rev 4350)
@@ -7,7 +7,7 @@
<section id="installation.standalone">
<title>Installing JBoss Messaging standalone</title>
<para>After downloading the distribution unzip it into your chosen directory. At this point it should be possible
- to run straight of the box, the following describes the directory structure that should be seen
+ to run straight out of the box, the following describes the directory structure that should be seen
</para>
<programlisting>
|-- bin
Modified: trunk/docs/userguide/en/modules/journal.xml
===================================================================
--- trunk/docs/userguide/en/modules/journal.xml 2008-05-29 22:28:20 UTC (rev 4349)
+++ trunk/docs/userguide/en/modules/journal.xml 2008-05-30 10:21:50 UTC (rev 4350)
@@ -3,19 +3,34 @@
<title>The journal based persistence approach</title>
<section id="journal.asyncio">
<title>ASYNCIO</title>
- <para>If you are using JBoss Messaging 2 on a Linux system, you can take full advantage of this feature. All you have to do is to make sure libaio is installed and you are using ext3 or ext2 or newer kernels.</para>
- <para>Instead of synchronizing the whole disk on every commit required by the journal, We submit writes directly to the kernel and we get callbacks when the information is stored on the hard drive. With that
- we maximize performance by one transaction not affecting other transaction's and using Direct Memory Access between the Journal and the Kernel. With AIO you can have high rate transactions even when you commit several small transactions.
- We are planing migrating this native liraries to other platforms besides Linux, as other OS's will have different options for Asynchronous IO.</para>
+ <para>If you are using JBoss Messaging 2 on a Linux system, you can take full advantage of this feature. All you
+ have to do is to make sure libaio is installed and you are using ext3 or ext2 or newer kernels.
+ </para>
+ <para>to install libaio on Fedora or Red Hat run the command 'yum install libaio' or on Ubuntu run either 'sudo
+ apt-get install libaio' or 'aptitude install libaio1'. For other OS's refer to the OS manual.
+ </para>
+ <para>Instead of synchronizing the whole disk on every commit required by the journal, We submit writes directly
+ to the kernel and we get callbacks when the information is stored on the hard drive. With that
+ we maximize performance by isolating the persistnce of one transaction from another and also by using Direct
+ Memory Access between the Journal and the Kernel. With AIO you can have high rate transactions even when you
+ commit several small transactions.
+ We are planing migrating this native liraries to other platforms besides Linux, as other OS's will have
+ different options for Asynchronous IO.
+ </para>
</section>
<section id="journal.nio">
<title>NIO</title>
- <para>Even though AIO takes a lot of advantage of the Linux Kernel specific features, NIO is not bad on performance at all.</para>
- <para>In fact both NIO and AIO journals share a lot of its implementation on an abstract class and we have verified that even our Journal with NIO is performing better than our competition.</para>
+ <para>If AIO is not available JBM will fall back to using NIO.</para>
+ <para>Both NIO and AIO journals share a lot of its implementation at an abstract level and we have verified that
+ even our Journal using NIO will perform well.
+ </para>
</section>
<section id="journal.jdbc">
<title>JDBC</title>
- <para>We are not supporting any JDBC mapping on JBoss Messaging 2 Alpha. JDBC is planned for Beta for users that require a database for management purposes.
- We will of course optimize JDBC access but we won't expect a lot of performance for persistent messages on JDBC as a relational database wasn't designed to the demand levels required by a Messaging System.</para>
+ <para>We are not supporting any JDBC mapping on JBoss Messaging 2 Alpha. JDBC is planned for Beta for users that
+ require a database for management purposes.
+ We will of course optimize JDBC access but we won't expect a lot of performance for persistent messages on JDBC
+ as a relational database wasn't designed to the demand levels required by a Messaging System.
+ </para>
</section>
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/modules/runningexamples.xml
===================================================================
--- trunk/docs/userguide/en/modules/runningexamples.xml 2008-05-29 22:28:20 UTC (rev 4349)
+++ trunk/docs/userguide/en/modules/runningexamples.xml 2008-05-30 10:21:50 UTC (rev 4350)
@@ -21,8 +21,7 @@
</para>
<para>For each example, you can always override the default ports it will
- try to connect to by editing jndi.properties in the particular example
- directory
+ try to connect to by editing jndi.properties in the config directory
</para>
<para>to run a specific example open up a shell or command prompt and navigate into the
<literal>examples/jms</literal>
@@ -39,7 +38,8 @@
[mkdir] Created dir: /home/andy/projects/jBossMessaging/docs/examples/jms/build
compile:
- [javac] Compiling 5 source files to /home/andy/projects/jBossMessaging/docs/examples/jms/build
+ [javac] Compiling 5 source files to /home/andy/projects/jBossMessaging/docs/
+ examples/jms/build
queueExample:
[java] 10:59:02,124 INFO @main [QueueExample] sending message to queue
@@ -90,6 +90,7 @@
set to false
</para>
<para>
+ The following parameters can be configured:
<itemizedlist>
<listitem>
<para>message.count</para>
@@ -172,7 +173,7 @@
<listitem>
<para>SSLClient</para>
<para>This example shows a simple send and receive to a remote queue using SS. The server will need to be
- running and configyred to use SSL for this example. Refer to the configuration chapter for details on how
+ running and configured to use SSL for this example. Refer to the configuration chapter for details on how
to do this
</para>
</listitem>
More information about the jboss-cvs-commits
mailing list