Class Http2StreamChannelOption<T>

java.lang.Object

io.netty.util.AbstractConstant<ChannelOption<T>>

io.netty.channel.ChannelOption<T>

io.netty.handler.codec.http2.Http2StreamChannelOption<T>

Type Parameters:

T - the type of the value which is valid for the ChannelOption

All Implemented Interfaces:

Constant<ChannelOption<T>>, Comparable<ChannelOption<T>>

public final class Http2StreamChannelOption<T>
extends ChannelOption<T>

ChannelOptions that are specific to Http2StreamChannels.

Field Summary

Fields

Modifier and Type	Field	Description
static final ChannelOption<Boolean>	AUTO_STREAM_FLOW_CONTROL	When set to true Http2WindowUpdateFrames will be automatically be generated and written for Http2StreamChannels as soon as frames are passed to the user via ChannelPipeline.fireChannelRead(Object).

Fields inherited from class ChannelOption

ALLOCATOR, ALLOW_HALF_CLOSURE, AUTO_CLOSE, AUTO_READ, CONNECT_TIMEOUT_MILLIS, DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION, IP_MULTICAST_ADDR, IP_MULTICAST_IF, IP_MULTICAST_LOOP_DISABLED, IP_MULTICAST_TTL, IP_TOS, MAX_MESSAGES_PER_READ, MAX_MESSAGES_PER_WRITE, MESSAGE_SIZE_ESTIMATOR, RCVBUF_ALLOCATOR, SINGLE_EVENTEXECUTOR_PER_GROUP, SO_BACKLOG, SO_BROADCAST, SO_KEEPALIVE, SO_LINGER, SO_RCVBUF, SO_REUSEADDR, SO_SNDBUF, SO_TIMEOUT, TCP_FASTOPEN, TCP_FASTOPEN_CONNECT, TCP_NODELAY, WRITE_BUFFER_HIGH_WATER_MARK, WRITE_BUFFER_LOW_WATER_MARK, WRITE_BUFFER_WATER_MARK, WRITE_SPIN_COUNT

Modifier and Type	Field	Description
static final ChannelOption<ByteBufAllocator>	ALLOCATOR
static final ChannelOption<Boolean>	ALLOW_HALF_CLOSURE
static final ChannelOption<Boolean>	AUTO_CLOSE	If true then the Channel is closed automatically and immediately on write failure.
static final ChannelOption<Boolean>	AUTO_READ
static final ChannelOption<Integer>	CONNECT_TIMEOUT_MILLIS
static final ChannelOption<Boolean>	DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION	Deprecated.
static final ChannelOption<InetAddress>	IP_MULTICAST_ADDR
static final ChannelOption<NetworkInterface>	IP_MULTICAST_IF
static final ChannelOption<Boolean>	IP_MULTICAST_LOOP_DISABLED
static final ChannelOption<Integer>	IP_MULTICAST_TTL
static final ChannelOption<Integer>	IP_TOS
static final ChannelOption<Integer>	MAX_MESSAGES_PER_READ	Deprecated. Use MaxMessagesRecvByteBufAllocator and MaxMessagesRecvByteBufAllocator.maxMessagesPerRead(int).
static final ChannelOption<Integer>	MAX_MESSAGES_PER_WRITE
static final ChannelOption<MessageSizeEstimator>	MESSAGE_SIZE_ESTIMATOR
static final ChannelOption<RecvByteBufAllocator>	RCVBUF_ALLOCATOR
static final ChannelOption<Boolean>	SINGLE_EVENTEXECUTOR_PER_GROUP
static final ChannelOption<Integer>	SO_BACKLOG
static final ChannelOption<Boolean>	SO_BROADCAST
static final ChannelOption<Boolean>	SO_KEEPALIVE
static final ChannelOption<Integer>	SO_LINGER
static final ChannelOption<Integer>	SO_RCVBUF
static final ChannelOption<Boolean>	SO_REUSEADDR
static final ChannelOption<Integer>	SO_SNDBUF
static final ChannelOption<Integer>	SO_TIMEOUT
static final ChannelOption<Integer>	TCP_FASTOPEN	Server-side TCP FastOpen.
static final ChannelOption<Boolean>	TCP_FASTOPEN_CONNECT	Client-side TCP FastOpen.
static final ChannelOption<Boolean>	TCP_NODELAY
static final ChannelOption<Integer>	WRITE_BUFFER_HIGH_WATER_MARK	Deprecated. Use ChannelOption.WRITE_BUFFER_WATER_MARK
static final ChannelOption<Integer>	WRITE_BUFFER_LOW_WATER_MARK	Deprecated. Use ChannelOption.WRITE_BUFFER_WATER_MARK
static final ChannelOption<WriteBufferWaterMark>	WRITE_BUFFER_WATER_MARK
static final ChannelOption<Integer>	WRITE_SPIN_COUNT

Method Summary

Methods inherited from class ChannelOption

exists, newInstance, validate, valueOf, valueOf

Modifier and Type	Method	Description
static boolean	exists(String name)	Returns true if a ChannelOption exists for the given name.
static <T> ChannelOption<T>	newInstance(String name)	Deprecated. use ChannelOption.valueOf(String).
void	validate(T value)	Validate the value which is set for the ChannelOption.
static <T> ChannelOption<T>	valueOf(Class<?> firstNameComponent, String secondNameComponent)	Shortcut of valueOf(firstNameComponent.getName() + "#" + secondNameComponent).
static <T> ChannelOption<T>	valueOf(String name)	Returns the ChannelOption of the specified name.

Methods inherited from class AbstractConstant

compareTo, equals, hashCode, id, name, toString

Modifier and Type	Method	Description
final int	compareTo(ChannelOption<T> o)
final boolean	equals(Object obj)
final int	hashCode()
final int	id()	Returns the unique number assigned to this Constant.
final String	name()	Returns the name of this Constant.
final String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

AUTO_STREAM_FLOW_CONTROL

public static final ChannelOption<Boolean> AUTO_STREAM_FLOW_CONTROL

When set to true Http2WindowUpdateFrames will be automatically be generated and written for Http2StreamChannels as soon as frames are passed to the user via ChannelPipeline.fireChannelRead(Object). If the user wants more control on when a window update is send its possible to set it to false. In this case the user is responsible to generate the correct Http2WindowUpdateFrames and eventually write these to the channel.

See RFC9113 5.2. Flow Control for more details.