Package io.netty.handler.codec.redis

Class RedisEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<RedisMessage>

io.netty.handler.codec.redis.RedisEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

@UnstableApi
public class RedisEncoder
extends MessageToMessageEncoder<RedisMessage>

Encodes RedisMessage into bytes following RESP (REdis Serialization Protocol).

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
RedisEncoder()	Creates a new instance with default messagePool.
RedisEncoder(RedisMessagePool messagePool)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	encode(ChannelHandlerContext ctx, RedisMessage msg, java.util.List<java.lang.Object> out)	Encode from one message to an other.

Methods inherited from class io.netty.handler.codec.MessageToMessageEncoder

acceptOutboundMessage, write

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

RedisEncoder

public RedisEncoder()

Creates a new instance with default messagePool.

RedisEncoder

public RedisEncoder(RedisMessagePool messagePool)

Creates a new instance.

Parameters:

messagePool - the predefined message pool.

Method Detail

encode

protected void encode(ChannelHandlerContext ctx,
                      RedisMessage msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.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<RedisMessage>

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:

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