Class DelimiterBasedFrameDecoder

java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelInboundHandlerAdapter
io.netty.handler.codec.ByteToMessageDecoder
io.netty.handler.codec.DelimiterBasedFrameDecoder
All Implemented Interfaces:
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 |
+----------+

  • Constructor Details

    • DelimiterBasedFrameDecoder

      public DelimiterBasedFrameDecoder(int maxFrameLength, ByteBuf delimiter)
      Creates a new instance.
      Parameters:
      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.
      Parameters:
      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.
      Parameters:
      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.
      Parameters:
      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.
      Parameters:
      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.
      Parameters:
      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

  • Method Details