andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

More stuff in the user guide

Browse Source
This commit is contained in:
Trustin Lee 2009-04-10 03:16:37 +00:00
parent 87fd349c66
commit 2e88f7a108
3 changed files with 161 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
src/docbook/module/architecture.xml
View File

@ -181,18 +181,58 @@
</section>
<section>
<title>Miscellaneous Constructs</title>
<title>Advanced Components for More Rapid Development</title>
<para>
On top of the core components mentioned above, that already enable the
implementation of all types of network applications, Netty provides a set
of advanced features to accelerate the development pace even more.
</para>
<section>
<title>Codec framework</title>
<para>
As demonstrated in <xref linkend="start.pojo"/>, it is always a good
idea to separate a protocol codec from a business logic. However, there
are some complications when implementing this idea from scratch. You
have to deal with the fragmentation of messages. Some protocols are a
multi-layered protocol built on top of other lower level protocol. Some
are too complicated to be implemented as a single state machine.
</para>
<para>
Consequently, a good network application framework should provide an
extensible, reusable, unit-testable, and multi-layered codec framework
that generates maintainable user codec.
</para>
<para>
Netty provides a number of fundamental and advanced codecs built on top
of the core to address most issues you will encounter when you write a
protocol codec regardless if it is simple or not, binary or text -
simply whatever.
</para>
</section>
<section>
<title>A View from the Feature Set Standpoint</title>
<title>SSL / TLS Support</title>
<para>
</para>
</section>
<section>
<title>HTTP Implementation</title>
<para>
</para>
</section>
<section>
<title>Google Protocol Buffer Integration</title>
<para>
</para>
</section>
</section>
<section>
<title>Summary</title>
<para>

19
src/docbook/module/buffer.xml
View File

@ -4,7 +4,7 @@
%CustomDTD;
]>
<chapter id="buffer">
<title>ChannelBuffer</title>
<title>ChannelBuffer - Why and How</title>
<para>
As mentioned in <xref linkend="architecture"/>, Netty uses its own buffer
API instead of NIO <classname>ByteBuffer</classname> to represent a sequence
@ -13,12 +13,8 @@
augment its behavior at all. Netty's new buffer type, &ChannelBuffer; has
been designed from ground up to address the problems of
<classname>ByteBuffer</classname> and to meet the daily needs of network
application developers.
</para>
<section>
<title>The Advantages of Using New Buffer API</title>
<para>
application developers. In this chapter, we will overview the features of
the new buffer API to explain what exactly it is good for.
</para>
<section>
@ -135,7 +131,7 @@ dynamicBuffer.writeByte('7');</programlisting>
with the specified initial capacity (4).
</para>
</callout>
<callout arearefs="example.buffer2.co3">
<callout arearefs="example.buffer3.co3">
<para>
When the number of written bytes exceeds the initial capacity (4),
the internal buffer is reallocated automatically with a larger
@ -144,11 +140,14 @@ dynamicBuffer.writeByte('7');</programlisting>
</callout>
</calloutlist>
</section>
</section>
<section>
<title>Summary</title>
<title>Documentation in progress</title>
<para>
This user guide is still under construction and waiting for your feed
back. Any idea to improve the documentation is more than appreciated.
Please join us in the <ulink url="&Community;">community</ulink> now to
share your idea!
</para>
</section>
</chapter>

2
src/docbook/module/start.xml
View File

@ -829,7 +829,7 @@ public class TimeDecoder extends &ReplayingDecoder;&lt;&VoidEnum;&gt; {
</section>
</section>
<section>
<section id="start.pojo">
<title>
Speaking in POJO instead of ChannelBuffer
</title>