io.netty.handler.codec

Class MessageToByteEncoder<I>

java.lang.Object

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

io.netty.handler.codec.MessageToByteEncoder<I>

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundHandler, io.netty.channel.ChannelOutboundMessageHandler<I>

Direct Known Subclasses:

CompatibleMarshallingEncoder, CompatibleObjectEncoder, LengthFieldPrepender, MarshallingEncoder, ObjectEncoder, ProtobufVarint32LengthFieldPrepender

public abstract class MessageToByteEncoder<I>
extends io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
MessageToByteEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	encode(io.netty.channel.ChannelHandlerContext ctx, I msg, io.netty.buffer.ByteBuf out)
void	flush(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.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

MessageToByteEncoder

public MessageToByteEncoder()

Method Detail

flush

public void flush(io.netty.channel.ChannelHandlerContext ctx,
         io.netty.channel.ChannelFuture future)
           throws Exception

Specified by:

flush in interface io.netty.channel.ChannelOperationHandler

Specified by:

flush in class io.netty.channel.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 void encode(io.netty.channel.ChannelHandlerContext ctx,
          I msg,
          io.netty.buffer.ByteBuf out)
                     throws Exception

Throws:

Exception