Class DecoratingHttp2ConnectionEncoder

java.lang.Object

io.netty.handler.codec.http2.DecoratingHttp2FrameWriter

io.netty.handler.codec.http2.DecoratingHttp2ConnectionEncoder

All Implemented Interfaces:

Http2ConnectionEncoder, Http2DataWriter, Http2FrameWriter, Http2SettingsReceivedConsumer, Closeable, AutoCloseable

Direct Known Subclasses:

CompressorHttp2ConnectionEncoder, StreamBufferingEncoder

public class DecoratingHttp2ConnectionEncoder
extends DecoratingHttp2FrameWriter
implements Http2ConnectionEncoder, Http2SettingsReceivedConsumer

A decorator around another Http2ConnectionEncoder instance.

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

Constructor Summary

Constructors

Constructor	Description
DecoratingHttp2ConnectionEncoder(Http2ConnectionEncoder delegate)

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class DecoratingHttp2FrameWriter

close, configuration, writeData, writeFrame, 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	writeData(ChannelHandlerContext ctx, int streamId, ByteBuf data, int padding, boolean endStream, ChannelPromise promise)	Writes a DATA frame to the remote endpoint.
ChannelFuture	writeFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, ByteBuf payload, ChannelPromise promise)	Generic write method for any HTTP/2 frame.
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.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Http2ConnectionEncoder

writeFrame

Modifier and Type	Method	Description
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.

Constructor Details

DecoratingHttp2ConnectionEncoder

public DecoratingHttp2ConnectionEncoder(Http2ConnectionEncoder delegate)

Method Details

lifecycleManager

public void lifecycleManager(Http2LifecycleManager lifecycleManager)

Description copied from interface: Http2ConnectionEncoder

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

Specified by:

lifecycleManager in interface Http2ConnectionEncoder

connection

public Http2Connection connection()

Description copied from interface: Http2ConnectionEncoder

Provides direct access to the underlying connection.

Specified by:

connection in interface Http2ConnectionEncoder

flowController

public Http2RemoteFlowController flowController()

Description copied from interface: Http2ConnectionEncoder

Provides the remote flow controller for managing outbound traffic.

Specified by:

flowController in interface Http2ConnectionEncoder

frameWriter

public Http2FrameWriter frameWriter()

Description copied from interface: Http2ConnectionEncoder

Provides direct access to the underlying frame writer object.

Specified by:

frameWriter in interface Http2ConnectionEncoder

pollSentSettings

public Http2Settings pollSentSettings()

Description copied from interface: Http2ConnectionEncoder

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

Specified by:

pollSentSettings in interface Http2ConnectionEncoder

remoteSettings

public void remoteSettings(Http2Settings settings)
                    throws Http2Exception

Description copied from interface: Http2ConnectionEncoder

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

Specified by:

remoteSettings in interface Http2ConnectionEncoder

Throws:

Http2Exception

consumeReceivedSettings

public void consumeReceivedSettings(Http2Settings settings)

Description copied from interface: Http2SettingsReceivedConsumer

Consume the most recently received but not yet ACKed settings.

Specified by:

consumeReceivedSettings in interface Http2SettingsReceivedConsumer