public class DefaultHttp2ConnectionEncoder extends Object implements Http2ConnectionEncoder, Http2SettingsReceivedConsumer
Http2ConnectionEncoder.| Modifier and Type | Class and Description |
|---|---|
class |
DefaultHttp2ConnectionEncoder.FlowControlledBase
Common base type for payloads to deliver via flow-control.
|
Http2FrameWriter.Configuration | Constructor and Description |
|---|
DefaultHttp2ConnectionEncoder (Http2Connection connection,
Http2FrameWriter frameWriter) |
| Modifier and Type | Method and 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.
|
ChannelFuture |
writeData (ChannelHandlerContext ctx,
int streamId,
ByteBuf data,
int padding,
boolean endOfStream,
ChannelPromise promise)
Writes a
DATA frame to the remote endpoint. |
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. |
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 endOfStream,
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.
|
public DefaultHttp2ConnectionEncoder(Http2Connection connection, Http2FrameWriter frameWriter)
public void lifecycleManager(Http2LifecycleManager lifecycleManager)
Http2ConnectionEncoder lifecycleManager in interface Http2ConnectionEncoder public Http2FrameWriter frameWriter()
Http2ConnectionEncoder frameWriter in interface Http2ConnectionEncoder public Http2Connection connection()
Http2ConnectionEncoder connection in interface Http2ConnectionEncoder public final Http2RemoteFlowController flowController()
Http2ConnectionEncoder flowController in interface Http2ConnectionEncoder public void remoteSettings(Http2Settings settings) throws Http2Exception
Http2ConnectionEncoder remoteSettings in interface Http2ConnectionEncoder Http2Exception public ChannelFuture writeData(ChannelHandlerContext ctx, int streamId, ByteBuf data, int padding, boolean endOfStream, ChannelPromise promise)
Http2DataWriter DATA frame to the remote endpoint. This will result in one or more
frames being written to the context.writeData in interface Http2DataWriter 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.public ChannelFuture writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, ChannelPromise promise)
Http2FrameWriter writeHeaders in interface Http2FrameWriter 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.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.
public ChannelFuture writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endOfStream, ChannelPromise promise)
Http2FrameWriter writeHeaders in interface Http2FrameWriter 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.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.
public ChannelFuture writePriority(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive, ChannelPromise promise)
Http2FrameWriter writePriority in interface Http2FrameWriter 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.public ChannelFuture writeRstStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise)
Http2FrameWriter writeRstStream in interface Http2FrameWriter 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.public ChannelFuture writeSettings(ChannelHandlerContext ctx, Http2Settings settings, ChannelPromise promise)
Http2FrameWriter writeSettings in interface Http2FrameWriter ctx - the context to use for writing.settings - the settings to be sent.promise - the promise for the write.public ChannelFuture writeSettingsAck(ChannelHandlerContext ctx, ChannelPromise promise)
Http2FrameWriter writeSettingsAck in interface Http2FrameWriter ctx - the context to use for writing.promise - the promise for the write.public ChannelFuture writePing(ChannelHandlerContext ctx, boolean ack, long data, ChannelPromise promise)
Http2FrameWriter writePing in interface Http2FrameWriter 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.public ChannelFuture writePushPromise(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding, ChannelPromise promise)
Http2FrameWriter writePushPromise in interface Http2FrameWriter 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.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.
public ChannelFuture writeGoAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise)
Http2FrameWriter writeGoAway in interface Http2FrameWriter 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.public ChannelFuture writeWindowUpdate(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement, ChannelPromise promise)
Http2FrameWriter writeWindowUpdate in interface Http2FrameWriter 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.public ChannelFuture writeFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, ByteBuf payload, ChannelPromise promise)
Http2ConnectionEncoder Http2FrameWriter without performing any
state checks on the connection/stream.writeFrame in interface Http2ConnectionEncoder writeFrame in interface Http2FrameWriter 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.public void close()
Http2FrameWriter close in interface Http2FrameWriter close in interface Closeable close in interface AutoCloseable public Http2Settings pollSentSettings()
Http2ConnectionEncoder null.pollSentSettings in interface Http2ConnectionEncoder public Http2FrameWriter.Configuration configuration()
Http2FrameWriter Http2FrameWriter configuration in interface Http2FrameWriter public void consumeReceivedSettings(Http2Settings settings)
Http2SettingsReceivedConsumer consumeReceivedSettings in interface Http2SettingsReceivedConsumer Copyright © 2008–2025 The Netty Project. All rights reserved.