You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by al...@apache.org on 2008/02/26 00:10:49 UTC
svn commit: r631034 - in
/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook:
references/ref.xml.component_descriptor.xml
tutorials_and_users_guides/tug.application.xml
Author: alally
Date: Mon Feb 25 15:10:48 2008
New Revision: 631034
URL: http://svn.apache.org/viewvc?rev=631034&view=rev
Log:
UIMA-821: https://issues.apache.org/jira/browse/UIMA-821
Documentation for setting the getMetaData timeout in the client
and the thread pool min/max sizes in the service.
Modified:
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml?rev=631034&r1=631033&r2=631034&view=diff
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml Mon Feb 25 15:10:48 2008
@@ -2142,6 +2142,7 @@
<parameters>
<parameter name="VNS_HOST" value="some.internet.ip.name-or-address"/>
<parameter name="VNS_PORT" value="9000"/>
+ <parameter name="GetMetaDataTimeout" value="[Integer]"/>
</parameters>
</uriSpecifier>]]></programlisting>
@@ -2163,8 +2164,22 @@
thrown. A value of zero or less will wait forever. If no timeout is specified, a default
value (currently 60 seconds) will be used.</para>
- <para>The parameter element is optional. If present, it specifies the Vinci naming
- service host and/or port number. If not present, the value used for these comes from
+ <para>The parameters element is optional. If present, it can specify values for each
+ of the following:
+ </para>
+ <itemizedlist>
+ <listitem><para><literal>VNS_HOST</literal>: host name for the Vinci naming service.
+ </para></listitem>
+ <listitem><para><literal>VNS_PORT</literal>: port number for the Vinci naming service.
+ </para></listitem>
+ <listitem><para><literal>GetMetaDataTimeout</literal>: timeout period (in milliseconds) for
+ the GetMetaData call. If not specified, the default is 60 seconds. This may need
+ to be set higher if there are a lot of clients competing for connections to the service.
+ </para></listitem>
+ </itemizedlist>
+
+ <para>If the <literal>VNS_HOST</literal> and <literal>VNS_PORT</literal> are not specified
+ in the descriptor, the values used for these comes from
parameters passed on the Java command line using the
<literal>-DVNS_HOST=<host></literal> and/or
<literal>-DVNS_PORT=<port></literal> system arguments. If not present, and
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml?rev=631034&r1=631033&r2=631034&view=diff
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml Mon Feb 25 15:10:48 2008
@@ -1231,6 +1231,18 @@
time, the server will presume the client may have gone away - and it <quote>cleans up</quote>, releasing any
resources it is holding. The next call to process on the service will result in a cycle which will cause the
client to re-establish its connection with the service (some additional overhead).</para>
+
+ <para>There are two additional parameters that you can add to your deployment descriptor:
+ </para>
+ <itemizedlist>
+ <listitem><para><literal><parameter name="threadPoolMinSize" value="[Integer]"/></literal>:
+ Specifies the number of threads that the Vinci service creates on startup in order to
+ serve clients' requests.</para></listitem>
+ <listitem><para><literal><parameter name="threadPoolMaxSize" value="[Integer]"/></literal>:
+ Specifies the maximum number of threads that the Vinci service will create. When the number of
+ concurrent requests exceeds the <literal>threadPoolMinSize</literal>, additional threads will be
+ created to serve requests, until the <literal>threadPoolMaxSize</literal> is reached.</para></listitem>
+ </itemizedlist>
<para>The <literal>startVinciService</literal> script takes two additional optional parameters. The
first one overrides the value of the VNS_HOST environment variable, allowing you to specify the name server
@@ -1590,6 +1602,13 @@
<olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.cpe_descriptor.descriptor.cas_processors.individual.error_handling"/>
) for details. </para>
+
+ <para>Note that the client timeout does not apply to the <literal>GetMetaData</literal>
+ request that is made when the client first connects to the service. This call is typically
+ very fast and does not need a large timeout (the default is 60 seconds). However, if many
+ clients are competing for a small number of services, it may be necessary to increase this
+ value. See <olink targetdoc="&uima_docs_ref;"
+ targetptr="ugr.ref.xml.component_descriptor.service_client"/></para>
</section>
<section id="ugr.tug.setting_server_socket_timeout">