Class FrameEncoder

  • All Implemented Interfaces:
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler
    Direct Known Subclasses:
    FrameEncoderCrc, FrameEncoderLZ4

    public abstract class FrameEncoder
    extends io.netty.channel.ChannelOutboundHandlerAdapter
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FrameEncoder.Payload
      An abstraction useful for transparently allocating buffers that can be written to upstream of the FrameEncoder without knowledge of the encoder's frame layout, while ensuring enough space to write the remainder of the frame's contents is reserved.
      static interface  FrameEncoder.PayloadAllocator  
      • Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        io.netty.channel.ChannelHandler.Sharable
    • Constructor Summary

      Constructors 
      Constructor Description
      FrameEncoder()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      FrameEncoder.PayloadAllocator allocator()  
      void write​(io.netty.channel.ChannelHandlerContext ctx, java.lang.Object msg, io.netty.channel.ChannelPromise promise)  
      • 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
    • Field Detail

      • bufferPool

        protected static final BufferPool bufferPool
    • Constructor Detail

      • FrameEncoder

        public FrameEncoder()
    • Method Detail

      • write

        public void write​(io.netty.channel.ChannelHandlerContext ctx,
                          java.lang.Object msg,
                          io.netty.channel.ChannelPromise promise)
                   throws java.lang.Exception
        Specified by:
        write in interface io.netty.channel.ChannelOutboundHandler
        Overrides:
        write in class io.netty.channel.ChannelOutboundHandlerAdapter
        Throws:
        java.lang.Exception