[jira] [Commented] (DAFFODIL-2057) Daffodil API doc not clear about what calls are thread-safe

["Steve Lawrence (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/DAFFODIL-2057?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16750264#comment-16750264 ] 

Steve Lawrence commented on DAFFODIL-2057:
------------------------------------------

The main [japi package summary page|https://daffodil.apache.org/docs/latest/javadoc/org/apache/daffodil/japi/package-summary.html] does mention that the parse() method is thread-safe, with the following:

{quote}
The DataProcessor.parse(org.apache.daffodil.japi.io.InputSourceDataInputStream, org.apache.daffodil.japi.infoset.InfosetOutputter) method is thread-safe and may be called multiple times without the need to create other data processors. However, InfosetOutputter's are not thread safe, requiring a unique instance per thread. An InfosetOutputter should call InfosetOutputter.reset() before reuse (or a new one should be allocated). For example:
{quote}

Do we need similar text somewhere else, or perhaps we need to move this to somewhere that is more visible? Maybe section entirely about which objects are thread-safe?

> Daffodil API doc not clear about what calls are thread-safe
> -----------------------------------------------------------
>
>                 Key: DAFFODIL-2057
>                 URL: https://issues.apache.org/jira/browse/DAFFODIL-2057
>             Project: Daffodil
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 2.2.0
>            Reporter: Michael Beckerle
>            Assignee: Steve Lawrence
>            Priority: Major
>             Fix For: 2.3.0
>
>
> Users report doc is unclear about what calls can be made on different threads.
> Given large memory footprint of a compiled schema this sharing ability needs to be discussed in javadoc/scaladoc of API.
>  
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)