Package io.netty.handler.codec.http2

Interface Http2DataWriter

All Known Subinterfaces:

Http2ConnectionEncoder, Http2FrameWriter

All Known Implementing Classes:

CompressorHttp2ConnectionEncoder, DecoratingHttp2ConnectionEncoder, DecoratingHttp2FrameWriter, DefaultHttp2ConnectionEncoder, DefaultHttp2FrameWriter, Http2OutboundFrameLogger, StreamBufferingEncoder

public interface Http2DataWriter

Interface that defines an object capable of producing HTTP/2 data frames.

Method Summary

Modifier and Type	Method	Description
io.netty.channel.ChannelFuture	writeData(io.netty.channel.ChannelHandlerContext ctx, int streamId, io.netty.buffer.ByteBuf data, int padding, boolean endStream, io.netty.channel.ChannelPromise promise)	Writes a DATA frame to the remote endpoint.

Method Detail

writeData

io.netty.channel.ChannelFuture writeData(io.netty.channel.ChannelHandlerContext ctx,
                                         int streamId,
                                         io.netty.buffer.ByteBuf data,
                                         int padding,
                                         boolean endStream,
                                         io.netty.channel.ChannelPromise promise)

Writes a DATA frame to the remote endpoint. This will result in one or more frames being written to the context.

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.

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.