[
https://issues.apache.org/jira/browse/FLUME-1019?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13225926#comment-13225926
]
[email protected] commented on FLUME-1019:
------------------------------------------------------
bq. On 2012-03-08 00:32:59, Mike Percy wrote:
bq. > Hi Juhani, sorry for the delay in getting back to you on this. I took a
look at the added docs and it looks great. I think this type of documentation
really helps to clarify how the system is supposed to act.
bq. >
bq. > I added a few suggestions below.
bq.
bq. Will McQueen wrote:
bq. Hi Juhani,
bq.
bq. How about adding some concurrency-related comments or annotations (eg,
JCIP-style, EJ-style or JSR-305 style... I'm not sure which one we've
standardized on for annotations, but I've seen some somewhere in the code
before) so that users know whether to make their custom implementations of
components (such as Sink) threadsafe, and so devs can tell at a glance whether
any future changes to the impl need to honor a specific thread safety contract?
EJ 2nd edition has Item 70: "Document thread safety". It recommends, "To enable
safe concurrent use, a class must clearly document what level of thread safety
it supports".
bq.
bq. Cheers,
bq. Will
Good point. I'll have to do this after the weekend but I'll get on it!
- Juhani
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/4175/#review5698
-----------------------------------------------------------
On 2012-03-09 07:51:16, Juhani Connolly wrote:
bq.
bq. -----------------------------------------------------------
bq. This is an automatically generated e-mail. To reply, visit:
bq. https://reviews.apache.org/r/4175/
bq. -----------------------------------------------------------
bq.
bq. (Updated 2012-03-09 07:51:16)
bq.
bq.
bq. Review request for Flume.
bq.
bq.
bq. Summary
bq. -------
bq.
bq. An initial pass at documenting the interfaces.
bq. Let me know if I missed anything relevant, or if you feel that this does
not correctly represent our expected behaviors.
bq.
bq.
bq. This addresses bug FLUME-1019.
bq. https://issues.apache.org/jira/browse/FLUME-1019
bq.
bq.
bq. Diffs
bq. -----
bq.
bq.
flume-ng-core/src/main/java/org/apache/flume/sink/SinkProcessorFactory.java
10f9f4e
bq. flume-ng-core/src/main/java/org/apache/flume/Sink.java 3abeeb6
bq. flume-ng-core/src/main/java/org/apache/flume/SinkProcessor.java 11651ad
bq. flume-ng-core/src/main/java/org/apache/flume/sink/SinkGroup.java 2e80a56
bq.
bq. Diff: https://reviews.apache.org/r/4175/diff
bq.
bq.
bq. Testing
bq. -------
bq.
bq. No changes have been made to code
bq.
bq.
bq. Thanks,
bq.
bq. Juhani
bq.
bq.
> Document Sink and related interfaces, defining expected behaviors
> -----------------------------------------------------------------
>
> Key: FLUME-1019
> URL: https://issues.apache.org/jira/browse/FLUME-1019
> Project: Flume
> Issue Type: Improvement
> Components: Sinks+Sources
> Affects Versions: v1.0.0, v1.1.0
> Reporter: Juhani Connolly
> Assignee: Juhani Connolly
> Fix For: v1.1.0
>
> Attachments: FLUME-1019.patch
>
>
> Currently the Sink interface is undocumented and some of the other public
> interfaces that might be implemented by users for custom sinks/processors are
> poorly documented.
> In the process of documenting these interfaces, I hope to get input from
> others on what our expected behavior is.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
