Package io.netty.handler.codec.http2

Class DefaultHttp2ConnectionEncoder

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes this writer and frees any allocated resources.
      Http2FrameWriter.Configuration configuration()
      Get the configuration related elements for this Http2FrameWriter
      Http2Connection connection()
      Provides direct access to the underlying connection.
      void consumeReceivedSettings​(Http2Settings settings)
      Consume the most recently received but not yet ACKed settings.
      Http2RemoteFlowController flowController()
      Provides the remote flow controller for managing outbound traffic.
      Http2FrameWriter frameWriter()
      Provides direct access to the underlying frame writer object.
      void lifecycleManager​(Http2LifecycleManager lifecycleManager)
      Sets the lifecycle manager.
      Http2Settings pollSentSettings()
      Gets the local settings on the top of the queue that has been sent but not ACKed.
      void remoteSettings​(Http2Settings settings)
      Sets the settings for the remote endpoint of the HTTP/2 connection.
      io.netty.channel.ChannelFuture writeData​(io.netty.channel.ChannelHandlerContext ctx, int streamId, io.netty.buffer.ByteBuf data, int padding, boolean endOfStream, io.netty.channel.ChannelPromise promise)
      Writes a DATA frame to the remote endpoint.
      io.netty.channel.ChannelFuture writeFrame​(io.netty.channel.ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, io.netty.buffer.ByteBuf payload, io.netty.channel.ChannelPromise promise)
      Writes the given data to the internal Http2FrameWriter without performing any state checks on the connection/stream.
      io.netty.channel.ChannelFuture writeGoAway​(io.netty.channel.ChannelHandlerContext ctx, int lastStreamId, long errorCode, io.netty.buffer.ByteBuf debugData, io.netty.channel.ChannelPromise promise)
      Writes a GO_AWAY frame to the remote endpoint.
      io.netty.channel.ChannelFuture writeHeaders​(io.netty.channel.ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, io.netty.channel.ChannelPromise promise)
      Writes a HEADERS frame to the remote endpoint.
      io.netty.channel.ChannelFuture writeHeaders​(io.netty.channel.ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endOfStream, io.netty.channel.ChannelPromise promise)
      Writes a HEADERS frame with priority specified to the remote endpoint.
      io.netty.channel.ChannelFuture writePing​(io.netty.channel.ChannelHandlerContext ctx, boolean ack, long data, io.netty.channel.ChannelPromise promise)
      Writes a PING frame to the remote endpoint.
      io.netty.channel.ChannelFuture writePriority​(io.netty.channel.ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive, io.netty.channel.ChannelPromise promise)
      Writes a PRIORITY frame to the remote endpoint.
      io.netty.channel.ChannelFuture writePushPromise​(io.netty.channel.ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding, io.netty.channel.ChannelPromise promise)
      Writes a PUSH_PROMISE frame to the remote endpoint.
      io.netty.channel.ChannelFuture writeRstStream​(io.netty.channel.ChannelHandlerContext ctx, int streamId, long errorCode, io.netty.channel.ChannelPromise promise)
      Writes a RST_STREAM frame to the remote endpoint.
      io.netty.channel.ChannelFuture writeSettings​(io.netty.channel.ChannelHandlerContext ctx, Http2Settings settings, io.netty.channel.ChannelPromise promise)
      Writes a SETTINGS frame to the remote endpoint.
      io.netty.channel.ChannelFuture writeSettingsAck​(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
      Writes a SETTINGS acknowledgment to the remote endpoint.
      io.netty.channel.ChannelFuture writeWindowUpdate​(io.netty.channel.ChannelHandlerContext ctx, int streamId, int windowSizeIncrement, io.netty.channel.ChannelPromise promise)
      Writes a WINDOW_UPDATE frame to the remote endpoint.

    • Method Detail

      • writeData

        public io.netty.channel.ChannelFuture writeData​(io.netty.channel.ChannelHandlerContext ctx,
                                                int streamId,
                                                io.netty.buffer.ByteBuf data,
                                                int padding,
                                                boolean endOfStream,
                                                io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2DataWriter
        Writes a DATA frame to the remote endpoint. This will result in one or more frames being written to the context.
        Specified by:
        writeData in interface Http2DataWriter
        Parameters:
        ctx - the context to use for writing.
        streamId - the stream for which to send the frame.
        data - the payload of the frame. This will be released by this method.
        padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). A 1 byte padding is encoded as just the pad length field with value 0. A 256 byte padding is encoded as the pad length field with value 255 and 255 padding bytes appended to the end of the frame.
        endOfStream - indicates if this is the last frame to be sent for the stream.
        promise - the promise for the write.
        Returns:
        the future for the write.

      • writeHeaders

        public io.netty.channel.ChannelFuture writeHeaders​(io.netty.channel.ChannelHandlerContext ctx,
                                                   int streamId,
                                                   Http2Headers headers,
                                                   int padding,
                                                   boolean endStream,
                                                   io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2FrameWriter
        Writes a HEADERS frame to the remote endpoint.
        Specified by:
        writeHeaders in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        streamId - the stream for which to send the frame.
        headers - the headers to be sent.
        padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
        endStream - indicates if this is the last frame to be sent for the stream.
        promise - the promise for the write.
        Returns:
        the future for the write. Section 10.5.1 states the following: 
         The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.
        If this call has modified the HPACK header state you MUST throw a connection error.

        If this call has NOT modified the HPACK header state you are free to throw a stream error.

      • writeHeaders

        public io.netty.channel.ChannelFuture writeHeaders​(io.netty.channel.ChannelHandlerContext ctx,
                                                   int streamId,
                                                   Http2Headers headers,
                                                   int streamDependency,
                                                   short weight,
                                                   boolean exclusive,
                                                   int padding,
                                                   boolean endOfStream,
                                                   io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2FrameWriter
        Writes a HEADERS frame with priority specified to the remote endpoint.
        Specified by:
        writeHeaders in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        streamId - the stream for which to send the frame.
        headers - the headers to be sent.
        streamDependency - the stream on which this stream should depend, or 0 if it should depend on the connection.
        weight - the weight for this stream.
        exclusive - whether this stream should be the exclusive dependant of its parent.
        padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
        endOfStream - indicates if this is the last frame to be sent for the stream.
        promise - the promise for the write.
        Returns:
        the future for the write. Section 10.5.1 states the following: 
         The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.
        If this call has modified the HPACK header state you MUST throw a connection error.

        If this call has NOT modified the HPACK header state you are free to throw a stream error.

      • writePriority

        public io.netty.channel.ChannelFuture writePriority​(io.netty.channel.ChannelHandlerContext ctx,
                                                    int streamId,
                                                    int streamDependency,
                                                    short weight,
                                                    boolean exclusive,
                                                    io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2FrameWriter
        Writes a PRIORITY frame to the remote endpoint.
        Specified by:
        writePriority in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        streamId - the stream for which to send the frame.
        streamDependency - the stream on which this stream should depend, or 0 if it should depend on the connection.
        weight - the weight for this stream.
        exclusive - whether this stream should be the exclusive dependant of its parent.
        promise - the promise for the write.
        Returns:
        the future for the write.

      • writeRstStream

        public io.netty.channel.ChannelFuture writeRstStream​(io.netty.channel.ChannelHandlerContext ctx,
                                                     int streamId,
                                                     long errorCode,
                                                     io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2FrameWriter
        Writes a RST_STREAM frame to the remote endpoint.
        Specified by:
        writeRstStream in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        streamId - the stream for which to send the frame.
        errorCode - the error code indicating the nature of the failure.
        promise - the promise for the write.
        Returns:
        the future for the write.

      • writeSettings

        public io.netty.channel.ChannelFuture writeSettings​(io.netty.channel.ChannelHandlerContext ctx,
                                                    Http2Settings settings,
                                                    io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2FrameWriter
        Writes a SETTINGS frame to the remote endpoint.
        Specified by:
        writeSettings in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        settings - the settings to be sent.
        promise - the promise for the write.
        Returns:
        the future for the write.

      • writeSettingsAck

        public io.netty.channel.ChannelFuture writeSettingsAck​(io.netty.channel.ChannelHandlerContext ctx,
                                                       io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2FrameWriter
        Writes a SETTINGS acknowledgment to the remote endpoint.
        Specified by:
        writeSettingsAck in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        promise - the promise for the write.
        Returns:
        the future for the write.

      • writePing

        public io.netty.channel.ChannelFuture writePing​(io.netty.channel.ChannelHandlerContext ctx,
                                                boolean ack,
                                                long data,
                                                io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2FrameWriter
        Writes a PING frame to the remote endpoint.
        Specified by:
        writePing in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        ack - indicates whether this is an ack of a PING frame previously received from the remote endpoint.
        data - the payload of the frame.
        promise - the promise for the write.
        Returns:
        the future for the write.

      • writePushPromise

        public io.netty.channel.ChannelFuture writePushPromise​(io.netty.channel.ChannelHandlerContext ctx,
                                                       int streamId,
                                                       int promisedStreamId,
                                                       Http2Headers headers,
                                                       int padding,
                                                       io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2FrameWriter
        Writes a PUSH_PROMISE frame to the remote endpoint.
        Specified by:
        writePushPromise in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        streamId - the stream for which to send the frame.
        promisedStreamId - the ID of the promised stream.
        headers - the headers to be sent.
        padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
        promise - the promise for the write.
        Returns:
        the future for the write. Section 10.5.1 states the following: 
         The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.
        If this call has modified the HPACK header state you MUST throw a connection error.

        If this call has NOT modified the HPACK header state you are free to throw a stream error.

      • writeGoAway

        public io.netty.channel.ChannelFuture writeGoAway​(io.netty.channel.ChannelHandlerContext ctx,
                                                  int lastStreamId,
                                                  long errorCode,
                                                  io.netty.buffer.ByteBuf debugData,
                                                  io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2FrameWriter
        Writes a GO_AWAY frame to the remote endpoint.
        Specified by:
        writeGoAway in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        lastStreamId - the last known stream of this endpoint.
        errorCode - the error code, if the connection was abnormally terminated.
        debugData - application-defined debug data. This will be released by this method.
        promise - the promise for the write.
        Returns:
        the future for the write.

      • writeWindowUpdate

        public io.netty.channel.ChannelFuture writeWindowUpdate​(io.netty.channel.ChannelHandlerContext ctx,
                                                        int streamId,
                                                        int windowSizeIncrement,
                                                        io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2FrameWriter
        Writes a WINDOW_UPDATE frame to the remote endpoint.
        Specified by:
        writeWindowUpdate in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        streamId - the stream for which to send the frame.
        windowSizeIncrement - the number of bytes by which the local inbound flow control window is increasing.
        promise - the promise for the write.
        Returns:
        the future for the write.

      • writeFrame

        public io.netty.channel.ChannelFuture writeFrame​(io.netty.channel.ChannelHandlerContext ctx,
                                                 byte frameType,
                                                 int streamId,
                                                 Http2Flags flags,
                                                 io.netty.buffer.ByteBuf payload,
                                                 io.netty.channel.ChannelPromise promise)
        Description copied from interface: Http2ConnectionEncoder
        Writes the given data to the internal Http2FrameWriter without performing any state checks on the connection/stream.
        Specified by:
        writeFrame in interface Http2ConnectionEncoder
        Specified by:
        writeFrame in interface Http2FrameWriter
        Parameters:
        ctx - the context to use for writing.
        frameType - the frame type identifier.
        streamId - the stream for which to send the frame.
        flags - the flags to write for this frame.
        payload - the payload to write for this frame. This will be released by this method.
        promise - the promise for the write.
        Returns:
        the future for the write.