Interface Http2ConnectionEncoder

All Superinterfaces:

AutoCloseable, Closeable, Http2DataWriter, Http2FrameWriter

All Known Implementing Classes:

CompressorHttp2ConnectionEncoder, DecoratingHttp2ConnectionEncoder, DefaultHttp2ConnectionEncoder, StreamBufferingEncoder

public interface Http2ConnectionEncoder
extends Http2FrameWriter

Handler for outbound HTTP/2 traffic.

Nested Class Summary

Nested classes/interfaces inherited from interface Http2FrameWriter

Http2FrameWriter.Configuration

Modifier and Type	Interface	Description
static interface	Http2FrameWriter.Configuration	Configuration specific to Http2FrameWriter

Method Summary

Modifier and Type	Method	Description
Http2Connection	connection()	Provides direct access to the underlying connection.
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.
ChannelFuture	writeFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, ByteBuf payload, ChannelPromise promise)	Writes the given data to the internal Http2FrameWriter without performing any state checks on the connection/stream.

Methods inherited from interface Http2DataWriter

writeData

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

Methods inherited from interface Http2FrameWriter

close, configuration, writeGoAway, writeHeaders, writeHeaders, writePing, writePriority, writePushPromise, writeRstStream, writeSettings, writeSettingsAck, writeWindowUpdate

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
ChannelFuture	writeGoAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise)	Writes a GO_AWAY frame to the remote endpoint.
ChannelFuture	writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, ChannelPromise promise)	Writes a HEADERS frame to the remote endpoint.
ChannelFuture	writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endStream, ChannelPromise promise)	Writes a HEADERS frame with priority specified to the remote endpoint.
ChannelFuture	writePing(ChannelHandlerContext ctx, boolean ack, long data, ChannelPromise promise)	Writes a PING frame to the remote endpoint.
ChannelFuture	writePriority(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive, ChannelPromise promise)	Writes a PRIORITY frame to the remote endpoint.
ChannelFuture	writePushPromise(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding, ChannelPromise promise)	Writes a PUSH_PROMISE frame to the remote endpoint.
ChannelFuture	writeRstStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise)	Writes a RST_STREAM frame to the remote endpoint.
ChannelFuture	writeSettings(ChannelHandlerContext ctx, Http2Settings settings, ChannelPromise promise)	Writes a SETTINGS frame to the remote endpoint.
ChannelFuture	writeSettingsAck(ChannelHandlerContext ctx, ChannelPromise promise)	Writes a SETTINGS acknowledgment to the remote endpoint.
ChannelFuture	writeWindowUpdate(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement, ChannelPromise promise)	Writes a WINDOW_UPDATE frame to the remote endpoint.

Method Details

lifecycleManager

void lifecycleManager(Http2LifecycleManager lifecycleManager)

Sets the lifecycle manager. Must be called as part of initialization before the encoder is used.

connection

Http2Connection connection()

Provides direct access to the underlying connection.

flowController

Http2RemoteFlowController flowController()

Provides the remote flow controller for managing outbound traffic.

frameWriter

Http2FrameWriter frameWriter()

Provides direct access to the underlying frame writer object.

pollSentSettings

Http2Settings pollSentSettings()

Gets the local settings on the top of the queue that has been sent but not ACKed. This may return null.

remoteSettings

void remoteSettings(Http2Settings settings)
             throws Http2Exception

Sets the settings for the remote endpoint of the HTTP/2 connection.

Throws:

Http2Exception

writeFrame

ChannelFuture writeFrame(ChannelHandlerContext ctx,
 byte frameType,
 int streamId,
 Http2Flags flags,
 ByteBuf payload,
 ChannelPromise promise)

Writes the given data to the internal Http2FrameWriter without performing any state checks on the connection/stream.

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.