Class MqttDecoder

All Implemented Interfaces:
ChannelHandler, ChannelInboundHandler

public final class MqttDecoder extends ReplayingDecoder<io.netty.handler.codec.mqtt.MqttDecoder.DecoderState>
Decodes Mqtt messages from bytes, following the MQTT protocol specification v3.1 or v5.0, depending on the version specified in the CONNECT message that first goes through the channel.
  • Constructor Details

    • MqttDecoder

      public MqttDecoder()
    • MqttDecoder

      public MqttDecoder(int maxBytesInMessage)
    • MqttDecoder

      public MqttDecoder(int maxBytesInMessage, int maxClientIdLength)
    • MqttDecoder

      public MqttDecoder(int maxBytesInMessage, int maxClientIdLength, boolean strictUtf8Validation)
      Creates a new MqttDecoder.
      Parameters:
      maxBytesInMessage - the maximum number of bytes a decoded message may consume.
      maxClientIdLength - the maximum length of the Client Identifier (CONNECT payload).
      strictUtf8Validation - if true (default), every UTF-8 Encoded String is validated according to MQTT 3.1.1 and MQTT 5.0 malformed UTF-8 sequences (including surrogates and overlong forms) and an embedded U+0000 are rejected as a Malformed Packet. If false, the legacy behaviour is preserved, malformed bytes are silently replaced with U+FFFD and U+0000 is accepted.
  • Method Details

    • maxBytesInMessage

      public int maxBytesInMessage()
      Returns the maximum number of bytes a decoded message may consume.
    • setMaxBytesInMessage

      public void setMaxBytesInMessage(int maxBytesInMessage)
      Sets the maximum number of bytes a decoded message may consume. The new limit applies to the next message to start decoding. A message whose fixed header has already been read continues to be decoded against the limit which was in force when it started.
      Parameters:
      maxBytesInMessage - the maximum number of bytes a decoded message may consume.
    • decode

      protected void decode(ChannelHandlerContext ctx, ByteBuf buffer, List<Object> out) throws Exception
      Description copied from class: 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.
      Specified by:
      decode in class ByteToMessageDecoder
      Parameters:
      ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to
      buffer - the ByteBuf from which to read data
      out - the List to which decoded messages should be added
      Throws:
      Exception - is thrown if an error occurs