Top Description Methods
io.netty5.handler.codec.http2

public Interface Http2ConnectionEncoder

extends Http2FrameWriter
Known Direct Implementers
io.netty5.handler.codec.http2.DecoratingHttp2ConnectionEncoder, io.netty5.handler.codec.http2.DefaultHttp2ConnectionEncoder
Annotations
@UnstableApi
Imports
io.netty5.buffer.Buffer, io.netty5.channel.ChannelHandlerContext, io.netty5.util.concurrent.Future, io.netty5.util.internal.UnstableApi

Handler for outbound HTTP/2 traffic.

Method Summary

Modifier and TypeMethod and Description
public Http2Connection
connection()

Provides direct access to the underlying connection.

public Http2RemoteFlowController
flowController()

Provides the remote flow controller for managing outbound traffic.

public Http2FrameWriter
frameWriter()

Provides direct access to the underlying frame writer object.

public void
lifecycleManager(Http2LifecycleManager lifecycleManager)

Sets the lifecycle manager.

public Http2Settings
pollSentSettings()

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

public void
remoteSettings(Http2Settings settings)

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

public Future<Void>
writeFrame(ChannelHandlerContext
the context to use for writing.
ctx
,
byte
the frame type identifier.
frameType
,
int
the stream for which to send the frame.
streamId
,
Http2Flags
the flags to write for this frame.
flags
,
Buffer
the payload to write for this frame. This will be released by this method.
payload
)

Redeclares io.netty5.handler.codec.http2.Http2FrameWriter.writeFrame.

Writes the given data to the internal Http2FrameWriter without performing any state checks on the connection/stream.
Inherited from io.netty5.handler.codec.http2.Http2FrameWriter:
closeconfigurationwriteGoAwaywriteHeaderswriteHeaderswritePingwritePrioritywritePushPromisewriteRstStreamwriteSettingswriteSettingsAckwriteWindowUpdate

Method Detail

connectionback to summary
public Http2Connection connection()

Provides direct access to the underlying connection.

flowControllerback to summary
public Http2RemoteFlowController flowController()

Provides the remote flow controller for managing outbound traffic.

frameWriterback to summary
public Http2FrameWriter frameWriter()

Provides direct access to the underlying frame writer object.

lifecycleManagerback to summary
public void lifecycleManager(Http2LifecycleManager lifecycleManager)

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

pollSentSettingsback to summary
public Http2Settings pollSentSettings()

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

remoteSettingsback to summary
public void remoteSettings(Http2Settings settings) throws Http2Exception

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

writeFrameback to summary
public Future<Void> writeFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, Buffer payload)

Redeclares io.netty5.handler.codec.http2.Http2FrameWriter.writeFrame.

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

Parameters
ctx:ChannelHandlerContext

Doc from io.netty5.handler.codec.http2.Http2FrameWriter.writeFrame.

the context to use for writing.

frameType:byte

Doc from io.netty5.handler.codec.http2.Http2FrameWriter.writeFrame.

the frame type identifier.

streamId:int

Doc from io.netty5.handler.codec.http2.Http2FrameWriter.writeFrame.

the stream for which to send the frame.

flags:Http2Flags

Doc from io.netty5.handler.codec.http2.Http2FrameWriter.writeFrame.

the flags to write for this frame.

payload:Buffer

Doc from io.netty5.handler.codec.http2.Http2FrameWriter.writeFrame.

the payload to write for this frame. This will be released by this method.

Returns:Future<Void>

Doc from io.netty5.handler.codec.http2.Http2FrameWriter.writeFrame.

the future for the write.

Annotations
@Override