documentation tips

Trustin Lee trustin at gleamynode.net
Wed Dec 31 00:13:41 EST 2008


Hi Marian,

Thanks for your suggestion first of all!

On Tue, Dec 30, 2008 at 3:27 AM, Marian Stranecky
<marian.stranecky at mobilbonus.cz> wrote:
> Hi,
> That's me again :)
>
> I would like to share some ideas with you about what else should be yet
> documented a little bit more:
>
> - InterestOps and related getInterestOps() method - what is use case and how
> is it related to a "connection" lifecycle?

That's an interesting question.  For TCP/IP transport, it works only
when a channel is 'connected'.  ServerSocketChannel doesn't support
interestOps and you will get UnsupportedOperationException IIRC.

> - links to projects using Netty (I don't think Netty is just a startup so I
> am wondering if there are any more complex projects from which we can study
> more)

Good idea!  Let me update the web site when I have a chance.
Meanwhile, let me file a JIRA issue:

  * https://jira.jboss.org/jira/browse/NETTY-99

Please feel free to post a comment if you have launched an open source
project that depends on Netty. ;)

> - donwload links for wiki contributed examples so they can be downloaded and
> used (compiled and tried) very quickly (in best case I suppose use of maven,
> ant or Ivy?)

That's also a good idea.  Any contribution is appreciated. ;)

> building a more complex client side example of "resource adaptor" which
> efficiently polls a source of messages (e.g. db), encodes it and sends while
> receives from remote side asynchronously. This example should be able to
> show some hints and basic use of:
> - multithreading (message poll and sender workers)
> - management (e.g. watchdog or jmx)
> - message buffering with a blocking queue
> - possibly reconnecting (or repeatedly calling a connect())
>
> The above stated issues are the ones I am trying to solve right now. In case
> I reach success I will share it with you. But maybe there is a work done
> already?

You're right.  Except for JMX, all of them are doable with Netty, but
needs documentation to help quick start.

> I would also appreciate proper information in examples and posts about which
> netty version is used (can we make it a rule?)

All examples depend on the latest stable release unless specified
explicitly.  For example, HTTP example requires 3.1, which is not a
stable release yet.  If 3.1.0.GA is released, all examples should be
updated to depend on 3.1.0.GA.

HTH,

-- 
Trustin Lee, Principal Software Engineer, JBoss, a division of Red Hat
--
what we call human nature in actuality is human habit
--
http://gleamynode.net/



More information about the netty-users mailing list