uima-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jerry Cwiklik (JIRA)" <uima-...@incubator.apache.org>
Subject [jira] Created: (UIMA-1754) Incorrect description of getCAS() method in UIMA AS documentation
Date Wed, 31 Mar 2010 16:05:27 GMT
Incorrect description of getCAS() method in UIMA AS documentation

                 Key: UIMA-1754
                 URL: https://issues.apache.org/jira/browse/UIMA-1754
             Project: UIMA
          Issue Type: Bug
          Components: Async Scaleout
    Affects Versions: 2.3AS
            Reporter: Jerry Cwiklik

Chapter 4.2 The UimaAsynchronousEngine Interface describes UIMA AS client interface. Its description
of getCAS() tells the reader to call reset() or release() on the CAS before calling getCAS()
again. This is wrong when the client application uses an async style of sending CASes using
sendCAS() method. When using async calls, the framework actually releases a CAS *after* the
user's listener callback completes. The code calls release() if the user callback is *not*
provided. The only time when the user's code must call release() or reset() is when the *synchronous*
calls are made via sendAndReceive(). In this style of invocation, the framework does not call
release() nor reset() and it *is* user's responsibility to do so. 

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

View raw message