io.netty.handler.codec

Class MessageToMessageEncoder<I,O>

java.lang.Object

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

io.netty.handler.codec.MessageToMessageEncoder<I,O>

All Implemented Interfaces:

ChannelHandler, ChannelOperationHandler, ChannelOutboundHandler, ChannelOutboundMessageHandler<I>

Direct Known Subclasses:

Base64Encoder, ByteArrayEncoder, ProtobufEncoder, StringEncoder

public abstract class MessageToMessageEncoder<I,O>
extends ChannelOutboundMessageHandlerAdapter<I>

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
MessageToMessageEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
abstract O	encode(ChannelHandlerContext ctx, I msg)
void	flush(ChannelHandlerContext ctx, ChannelFuture future)
boolean	isEncodable(Object msg) Returns true if and only if the specified message can be encoded by this encoder.

Methods inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

newOutboundBuffer

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, bind, close, connect, deregister, disconnect, exceptionCaught, userEventTriggered

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.ChannelOperationHandler

bind, close, connect, deregister, disconnect

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

MessageToMessageEncoder

public MessageToMessageEncoder()

Method Detail

flush

public void flush(ChannelHandlerContext ctx,
         ChannelFuture future)
           throws Exception

Specified by:

flush in interface ChannelOperationHandler

Specified by:

flush in class ChannelOutboundHandlerAdapter

Throws:

Exception

isEncodable

public boolean isEncodable(Object msg)
                    throws Exception

Returns true if and only if the specified message can be encoded by this encoder.

Parameters:

msg - the message

Throws:

Exception

encode

public abstract O encode(ChannelHandlerContext ctx,
       I msg)
                  throws Exception

Throws:

Exception