Class MqttEncoder

io.netty.handler.codec.mqtt.MqttEncoder

All Implemented Interfaces:: ChannelHandler, ChannelOutboundHandler

@Sharable public final class MqttEncoder extends MessageToMessageEncoder<MqttMessage>

Encodes Mqtt messages into bytes following the protocol specification v3.1 as described here MQTTV3.1 or v5.0 as described here MQTTv5.0 - depending on the version specified in the first CONNECT message that goes through the channel.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler
ChannelHandler.Sharable
Field Summary

Fields

Modifier and Type

Field

Description

static final MqttEncoder

INSTANCE
Method Summary

Modifier and Type

Method

Description

protected void

encode (ChannelHandlerContext ctx, MqttMessage msg, List<Object> out)

Encode from one message to an other.

Methods inherited from class MessageToMessageEncoder
acceptOutboundMessage, write

Methods inherited from class ChannelOutboundHandlerAdapter
bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class ChannelHandlerAdapter
ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ChannelHandler
exceptionCaught, handlerAdded, handlerRemoved

Field Details
- INSTANCE
  
  public static final MqttEncoder INSTANCE
Method Details
- encode
  
  protected void encode(ChannelHandlerContext ctx, MqttMessage msg, List<Object> out) throws Exception
  
  Description copied from class: MessageToMessageEncoder
  
  Encode from one message to an other. This method will be called for each written message that can be handled by this encoder.
  
  Specified by:
  
  encode in class MessageToMessageEncoder<MqttMessage>
  
  Parameters:
  
  ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to
  
  msg - the message to encode to an other one
  
  out - the List into which the encoded msg should be added needs to do some kind of aggregation
  
  Throws:
  
  Exception - is thrown if an error occurs

Class MqttEncoder

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

Field Summary

Method Summary

Methods inherited from class MessageToMessageEncoder

Methods inherited from class ChannelOutboundHandlerAdapter

Methods inherited from class ChannelHandlerAdapter

Methods inherited from class Object

Methods inherited from interface ChannelHandler

Field Details

INSTANCE

Method Details

encode