As well as the very good suggestions that I've seen so far, I'd really
like to see documentation on the synchronization model used by Grizzly.
In particular, which classes/methods are thread-safe (incl. immutable)
as well as ordering specifications such as happens-before/happens-after.
As an example, the documentation for interface
com.sun.grizzly.filterchain.Filter indicates that implementations should
be thread-safe, which is a good start, but it would be nice to have a
more detailed specification regarding the order in which events can be
triggered for a connection. We recently ran into a problem where we
wrongly assumed that handleClose events for a connection happen-after
handleRead events.
Matt
On 02/09/10 19:43, Ryan Lubke wrote:
> Hey Folks,
>
> In our Grizzly meeting two weeks ago, we decided that documentation
> should be a primary goal for the initial 2.0 release.
>
> We think that creating this documentation using LaTeX or Docbook will
> provide a lot of benefit as far as how we can distribute the
> documentation (online, bundled, etc).
>
> We'd like to poll the community on topics they would like to see
> covered in addition to the items I've listed below:
>
> - core framework
> - http framework
> - web container framework
>
> Keep in mind, that we still need to start our outlines of what we
> think should be covered in these areas, so once we've gathered
> feedback we can incorporate the changes and produce the final outlines
> for review.
>
> Once the outlines are approved, we can being writing the documentation
> in earnest.
>
> Thanks,
>
> -rl
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe_at_grizzly.dev.java.net
> For additional commands, e-mail: dev-help_at_grizzly.dev.java.net
>