io.netty.handler.codec

类 DelimiterBasedFrameDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.DelimiterBasedFrameDecoder

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

public class DelimiterBasedFrameDecoder
extends ByteToMessageDecoder

A decoder that splits the received ByteBufs by one or more delimiters. It is particularly useful for decoding the frames which ends with a delimiter such as NUL or newline characters.

Predefined delimiters

Delimiters defines frequently used delimiters for convenience' sake.

Specifying more than one delimiter

DelimiterBasedFrameDecoder allows you to specify more than one delimiter. If more than one delimiter is found in the buffer, it chooses the delimiter which produces the shortest frame. For example, if you have the following data in the buffer:

 +--------------+
 | ABC\nDEF\r\n |
 +--------------+
 

a DelimiterBasedFrameDecoder(Delimiters.lineDelimiter()) will choose '\n' as the first delimiter and produce two frames:

 +-----+-----+
 | ABC | DEF |
 +-----+-----+
 

rather than incorrectly choosing '\r\n' as the first delimiter:

 +----------+
 | ABC\nDEF |
 +----------+
 

嵌套类概要

从类继承的嵌套类/接口 io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

字段概要

从类继承的字段 io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造器概要

构造器

构造器和说明
DelimiterBasedFrameDecoder(int maxFrameLength, boolean stripDelimiter, boolean failFast, ByteBuf... delimiters) Creates a new instance.
DelimiterBasedFrameDecoder(int maxFrameLength, boolean stripDelimiter, boolean failFast, ByteBuf delimiter) Creates a new instance.
DelimiterBasedFrameDecoder(int maxFrameLength, boolean stripDelimiter, ByteBuf... delimiters) Creates a new instance.
DelimiterBasedFrameDecoder(int maxFrameLength, boolean stripDelimiter, ByteBuf delimiter) Creates a new instance.
DelimiterBasedFrameDecoder(int maxFrameLength, ByteBuf... delimiters) Creates a new instance.
DelimiterBasedFrameDecoder(int maxFrameLength, ByteBuf delimiter) Creates a new instance.

方法概要

限定符和类型	方法和说明
protected java.lang.Object	decode(ChannelHandlerContext ctx, ByteBuf buffer) Create a frame out of the ByteBuf and return it.
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out) Decode the from one ByteBuf to an other.

从类继承的方法 io.netty.handler.codec.ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 io.netty.channel.ChannelHandler

handlerAdded

构造器详细资料

DelimiterBasedFrameDecoder

public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  ByteBuf delimiter)

Creates a new instance.

参数:

maxFrameLength - the maximum length of the decoded frame. A TooLongFrameException is thrown if the length of the frame exceeds this value.

delimiter - the delimiter

DelimiterBasedFrameDecoder

public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  boolean stripDelimiter,
                                  ByteBuf delimiter)

Creates a new instance.

参数:

maxFrameLength - the maximum length of the decoded frame. A TooLongFrameException is thrown if the length of the frame exceeds this value.

stripDelimiter - whether the decoded frame should strip out the delimiter or not

delimiter - the delimiter

DelimiterBasedFrameDecoder

public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  boolean stripDelimiter,
                                  boolean failFast,
                                  ByteBuf delimiter)

Creates a new instance.

参数:

maxFrameLength - the maximum length of the decoded frame. A TooLongFrameException is thrown if the length of the frame exceeds this value.

stripDelimiter - whether the decoded frame should strip out the delimiter or not

failFast - If true, a TooLongFrameException is thrown as soon as the decoder notices the length of the frame will exceed maxFrameLength regardless of whether the entire frame has been read. If false, a TooLongFrameException is thrown after the entire frame that exceeds maxFrameLength has been read.

delimiter - the delimiter

DelimiterBasedFrameDecoder

public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  ByteBuf... delimiters)

Creates a new instance.

参数:

maxFrameLength - the maximum length of the decoded frame. A TooLongFrameException is thrown if the length of the frame exceeds this value.

delimiters - the delimiters

DelimiterBasedFrameDecoder

public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  boolean stripDelimiter,
                                  ByteBuf... delimiters)

Creates a new instance.

参数:

maxFrameLength - the maximum length of the decoded frame. A TooLongFrameException is thrown if the length of the frame exceeds this value.

stripDelimiter - whether the decoded frame should strip out the delimiter or not

delimiters - the delimiters

DelimiterBasedFrameDecoder

public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  boolean stripDelimiter,
                                  boolean failFast,
                                  ByteBuf... delimiters)

Creates a new instance.

参数:

maxFrameLength - the maximum length of the decoded frame. A TooLongFrameException is thrown if the length of the frame exceeds this value.

stripDelimiter - whether the decoded frame should strip out the delimiter or not

failFast - If true, a TooLongFrameException is thrown as soon as the decoder notices the length of the frame will exceed maxFrameLength regardless of whether the entire frame has been read. If false, a TooLongFrameException is thrown after the entire frame that exceeds maxFrameLength has been read.

delimiters - the delimiters

方法详细资料

decode

protected final void decode(ChannelHandlerContext ctx,
                            ByteBuf in,
                            java.util.List<java.lang.Object> out)
                     throws java.lang.Exception

从类复制的说明: ByteToMessageDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

指定者:

decode 在类中 ByteToMessageDecoder

参数:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

抛出:

java.lang.Exception - is thrown if an error occurs

decode

protected java.lang.Object decode(ChannelHandlerContext ctx,
                                  ByteBuf buffer)
                           throws java.lang.Exception

Create a frame out of the ByteBuf and return it.

参数:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

buffer - the ByteBuf from which to read data

返回:

frame the ByteBuf which represent the frame or null if no frame could be created.

抛出:

java.lang.Exception