[HTTPCORE-305] Javadoc could be clearer about the scopes for the encoder/decoder....

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 4.2.2
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Daniel Kulp
• Created: 31/Jul/12 19:26
• Updated: 05/Oct/13 20:09
• Resolved: 07/Aug/12 11:31

Description

While working with hc for use with CXF, I tried using the encoder/decoder on a different thread, but ONLY on that different thread since they aren't marked threadsafe. However, I ran into some problems. The javadoc for produceContent and for the encoder/decoder interfaces likely should contain something like:

"The encoder should only be used within the context of the call to produceContent. The IOControl object can be retained and used on other threads to allow resuming events when appropriate."

to make it clear that the encoder/decoder should not be retained at all, but the IONControl object could be.