Author: cwiklik
Date: Mon Dec 20 20:04:15 2010
New Revision: 1051268
URL: http://svn.apache.org/viewvc?rev=1051268&view=rev
Log:
UIMA-1754 Modified description of getCas()
Modified:
uima/uima-as/trunk/uima-as-docbooks/src/docbook/ref.async.api.xml
Modified: uima/uima-as/trunk/uima-as-docbooks/src/docbook/ref.async.api.xml
URL:
http://svn.apache.org/viewvc/uima/uima-as/trunk/uima-as-docbooks/src/docbook/ref.async.api.xml?rev=1051268&r1=1051267&r2=1051268&view=diff
==============================================================================
--- uima/uima-as/trunk/uima-as-docbooks/src/docbook/ref.async.api.xml (original)
+++ uima/uima-as/trunk/uima-as-docbooks/src/docbook/ref.async.api.xml Mon Dec
20 20:04:15 2010
@@ -110,11 +110,15 @@ under the License.
</listitem>
<listitem>
- <para><code>CAS getCAS()</code>: Requests a new CAS instance from
the CAS pool. This method blocks
- until a free instance of CAS is available in the CAS pool.
- Applications that use <code>getCAS()</code> need to call
<code>CAS.reset()</code>
- before reusing the CAS, or <code>CAS.release()</code>
- to return it to the Cas pool.
+ <para><code>CAS getCAS()</code>: Requests a new CAS instance from a
CAS pool. This method
+ blocks until a free instance of CAS is available in the CAS pool.
Applications that
+ use synchronous <code>sendAndReceive()</code> and
<code>getCAS()</code> need to call
+ <code>CAS.reset()</code> before reusing the CAS, or
<code>CAS.release()</code> to return
+ it to the CAS pool. Applications that use asynchronous
<code>sendCAS()</code> and
+ <code>getCAS()</code> must not call <code>CAS.release()</code> nor
<code>CAS.reset()</code>
+ unless <code>sendCAS()</code> throws an exception. If
<code>sendCAS()</code> call is successful,
+ the UIMA AS framework code releases each CAS automatically when a
reply is received. The framework
+ releases a CAS right after a callback listener
<code>entityProcessComplete()</code> completes.
</para>
</listitem>
