[jboss-remoting-commits] JBoss Remoting SVN: r6338 - remoting2/branches/2.x/docs/guide/en.
jboss-remoting-commits at lists.jboss.org
jboss-remoting-commits at lists.jboss.org
Mon Apr 25 23:10:50 EDT 2011
Author: ron.sigal at jboss.com
Date: 2011-04-25 23:10:49 -0400 (Mon, 25 Apr 2011)
New Revision: 6338
Modified:
remoting2/branches/2.x/docs/guide/en/chap5.xml
Log:
JBREM-1283: Added discussion of configuring an executor in CoyoteInvoker.
Modified: remoting2/branches/2.x/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.x/docs/guide/en/chap5.xml 2011-04-25 23:47:54 UTC (rev 6337)
+++ remoting2/branches/2.x/docs/guide/en/chap5.xml 2011-04-26 03:10:49 UTC (rev 6338)
@@ -1815,30 +1815,44 @@
<para>The HTTP server invoker implementation is based on the Coyote
HTTP/1.1 Connector Tomcat component, which is supplied by the JBossWeb
- implementation, in jbossweb.jar.</para>
+ implementation in jbossweb.jar.</para>
<para><emphasis role="bold">Note.</emphasis> Prior to release 2.5.0.GA,
Remoting also was compatible with the Apache implementation of
- Tomcat, which is no longer the case. Since JBossWeb requires jdk 1.5 or above, it follows that the HTTP transport in Remoting 2.5.0.GA and above has the same requirement.</para>
+ Tomcat, which is no longer the case. Since JBossWeb requires jdk 1.5 or above,
+ it follows that the HTTP transport in Remoting 2.5.0.GA and above has the same requirement.</para>
<para>The coyote Connector supports GET, POST, HEAD, OPTIONS, and HEAD
method types and keep-alive, and most any configuration allowed for Tomcat
can be configured for the remoting HTTP server invoker. For more
information on the configuration attributes available for the Tomcat
connectors, please refer to <ulink
- url="http://tomcat.apache.org/tomcat-5.5-doc/config/http.html">http://tomcat.apache.org/tomcat-5.5-doc/config/http.html</ulink>.
- http://tomcat.apache.org/tomcat-5.5-doc/config/http.html <!--<link
- linkend="???">http://tomcat.apache.org/tomcat-5.5-doc/config/http.html</link>-->
- So for example, if wanted to set the maximum number of threads to be used
- to accept incoming http requests, would use the 'maxThreads' attribute.
- The only exception when should use remoting configuration over the Tomcat
- configuration is for attribute 'address' (use serverBindAddress instead)
- and attribute 'port' (use serverBindPort instead).</para>
+ url="http://tomcat.apache.org/tomcat-6.0-doc/config/http.html">http://tomcat.apache.org/tomcat-6.0-doc/config/http.html</ulink>.
+ The Tomcat parameters passed into the http server invoker are passed on
+ to Tomcat. For example, the Tomcat attribute "maxThreads" can be used to set the
+ maximum number of threads to be used to accept incoming http requests.
+ The only exceptions are the Remoting attributes "serverBindAddress" and
+ "serverBindPort", which should be used instead of the Tomcat attributes
+ "address" and "port".</para>
- <para>Note: The http invoker no longer has the configuration attributes
- 'maxNumThreadsHTTP' or 'HTTPThreadPool' as thread pooling is now handled
- within the Tomcat connectors, which does not expose external API for
- setting these.</para>
+ <para><emphasis role="bold">Note.</emphasis> An executor, subclassed from
+ <classname>java.util.concurrent.Executor</classname>, can be configured and
+ injected into the coyote Connector. As of release 2.5.4.SP2, Remoting can configure
+ and inject an instance of <classname>org.apache.catalina.core.StandardThreadExecutor</classname>.
+ The configurable attributes of the <classname>StandardThreadExecutor</classname>
+ are described in <ulink
+ url="http://tomcat.apache.org/tomcat-6.0-doc/config/executor.html">http://tomcat.apache.org/tomcat-6.0-doc/config/executor.html</ulink>.
+ These attributes may be passed to Remoting using the key "executor" and a string of
+ the form "attribute0=value0,...,attributeN=valueN". For example, a <code>*-service.xml</code> configuration file
+ could contain</para>
+
+ <programlisting><attribute name="executor">minSpareThreads=20,maxThreads=100</attribute></programlisting>
+
+ <para>Remoting will parse the comma separated list, ignoring white space, create and configure
+ a <classname>StandardThreadExecutor</classname>, and inject it into the coyote Connector. Note that
+ if an executor is injected, the other threadpool related attributes such as "maxThreads", which would otherwise
+ be applied to a threadpool created by the coyote Connector, are ignored.
+ </para>
<para>A feature introduced in Remoting version 2.4 is the ability to
configure <classname>HTTPClientInvoker</classname> to make multiple
@@ -1856,10 +1870,10 @@
possible to switch to use the
<code>org.apache.coyote.http11.Http11AprProtocol</code> protocol, which is
based on the Apache Portable Runtime (see <ulink
- url="http://www.jboss.org/file-access/default/members/jbossweb/freezone/docs/2.1.0/apr.html">
- http://www.jboss.org/file-access/default/members/jbossweb/freezone/docs/2.1.0/apr.html</ulink>
- for more details). If want to use the APR implementation, simply put the
- tcnative-1.dll (or tcnative-1.so) on the system path so can be loaded. The
+ url="http://tomcat.apache.org/tomcat-6.0-doc/apr.html">
+ http://tomcat.apache.org/tomcat-6.0-doc/apr.html</ulink>
+ for more details). To use the APR implementation, simply put the
+ tcnative-1.dll (or tcnative-1.so) on the system path so it can be loaded. The
JBossWeb native libraries, which include tcnative-1.dll/tcnative-1.so, may
be downloaded from <ulink
url="http://www.jboss.org/jbossweb/">http://www.jboss.org/jbossweb/</ulink>.</para>
@@ -6580,6 +6594,19 @@
</section>
<section>
+ <title>org.jboss.remoting.transport.coyote.CoyoteInvoker</title>
+
+ <para> <emphasis role="bold">"executor"</emphasis>: a comma separated list of attributes
+ associated with this key will be used to configure an
+ <classname>org.apache.catalina.core.StandardThreadExecutor</classname>, which
+ will then be injected into the underlying Coyote Connector. See
+ <ulink
+ url="http://tomcat.apache.org/tomcat-6.0-doc/config/executor.html">http://tomcat.apache.org/tomcat-6.0-doc/config/executor.html</ulink>.
+ for the available configurable attributes.
+ </para>
+ </section>
+
+ <section>
<title>org.jboss.remoting.transport.http.HTTPClientInvoker</title>
<para> <emphasis role="bold">NUMBER_OF_CALL_ATTEMPTS</emphasis> (actual
More information about the jboss-remoting-commits
mailing list