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

Almost finish javadocs for codec module

Browse Source
This commit is contained in:
Norman Maurer 2012-12-21 22:41:18 +01:00
parent b814033323
commit ff3dcffd49
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
codec/src/main/java/io/netty/handler/codec/protobuf/ProtobufDecoder.java
View File

@ -20,6 +20,7 @@ import io.netty.buffer.ByteBufInputStream;
import io.netty.channel.ChannelHandler.Sharable;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelPipeline;
import io.netty.handler.codec.ByteToMessageDecoder;
import io.netty.handler.codec.LengthFieldBasedFrameDecoder;
import io.netty.handler.codec.LengthFieldPrepender;
import io.netty.handler.codec.MessageToMessageDecoder;
@ -32,7 +33,7 @@ import com.google.protobuf.MessageLite;
* Decodes a received {@link ByteBuf} into a
* <a href="http://code.google.com/p/protobuf/">Google Protocol Buffers</a>
* {@link Message} and {@link MessageLite}. Please note that this decoder must
* be used with a proper {@link FrameDecoder} such as {@link ProtobufVarint32FrameDecoder}
* be used with a proper {@link ByteToMessageDecoder} such as {@link ProtobufVarint32FrameDecoder}
* or {@link LengthFieldBasedFrameDecoder} if you are using a stream-based
* transport such as TCP/IP. A typical setup for TCP/IP would be:
* <pre>
@ -51,8 +52,7 @@ import com.google.protobuf.MessageLite;
* and then you can use a {@code MyMessage} instead of a {@link ByteBuf}
* as a message:
* <pre>
* void messageReceived({@link ChannelHandlerContext} ctx, {@link MessageEvent} e) {
* MyMessage req = (MyMessage) e.getMessage();
* void messageReceived({@link ChannelHandlerContext} ctx, MyMessage req) {
* MyMessage res = MyMessage.newBuilder().setText(
* "Did you say '" + req.getText() + "'?").build();
* ch.write(res);

3
codec/src/main/java/io/netty/handler/codec/protobuf/ProtobufEncoder.java
View File

@ -47,8 +47,7 @@ import com.google.protobuf.MessageLite;
* and then you can use a {@code MyMessage} instead of a {@link ByteBuf}
* as a message:
* <pre>
* void messageReceived({@link ChannelHandlerContext} ctx, {@link MessageEvent} e) {
* MyMessage req = (MyMessage) e.getMessage();
* void messageReceived({@link ChannelHandlerContext} ctx, MyMessage req) {
* MyMessage res = MyMessage.newBuilder().setText(
* "Did you say '" + req.getText() + "'?").build();
* ch.write(res);