svn commit: r505439 - /incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml

[sc...@apache.org]

Author: schor
Date: Fri Feb  9 11:31:59 2007
New Revision: 505439

URL: http://svn.apache.org/viewvc?view=rev&rev=505439
Log:
No Jira - update CPE "dequeueTimeout" semantics indicating that
specifying 0 disables the time out - this is equivalent to
specifying an infinitely long timeout.  (Discovered during
code inspection, confirmed by Cwiklik)

Modified:
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml

Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml?view=diff&rev=505439&r1=505438&r2=505439
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml Fri Feb  9 11:31:59 2007
@@ -1129,14 +1129,17 @@
         
         <programlisting>&lt;outputQueue dequeueTimeout="100000" queueClass=
 "org.apache.uima.reference_impl.collection.cpm.engine.SequencedQueue"/&gt;</programlisting>
+        
         where the mandatory <literal>queueClass</literal> attribute defines the name of
         the class and the second mandatory attribute, <literal>dequeueTimeout</literal>
         specifies the maximum number of milliseconds to wait for the expected chunk.</para>
+      
       <note><para>The value for this timeout must be carefully determined to avoid
       excessive occurrences of timeouts. Typically, the size of a chunk and the type of
       analysis being done are the most important factors when deciding on the value for the
       timeout. The larger the chunk and the more complicated analysis, the more time it takes
-      for the chunk to go from source to sink. </para></note>
+      for the chunk to go from source to sink. You may specify 0, in which case, the timeout is 
+      disabled - i.e., it is equivalent to an infinitely long timeout.</para></note>
       
       <para>If the chunk doesn&apos;t arrive in the configured time window, the entire
         document is presumed to be invalid and the CAS is dropped from further processing.