Class QuicServerCodecBuilder

java.lang.Object

io.netty.handler.codec.quic.QuicCodecBuilder<QuicServerCodecBuilder>

io.netty.handler.codec.quic.QuicServerCodecBuilder

public final class QuicServerCodecBuilder
extends QuicCodecBuilder<QuicServerCodecBuilder>

QuicCodecBuilder that configures and builds a ChannelHandler that should be added to the ChannelPipeline of a QUIC server.

Constructor Summary

Constructors

Constructor	Description
QuicServerCodecBuilder()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
<T> QuicServerCodecBuilder	attr(AttributeKey<T> key, T value)	Allow to specify an initial attribute of the newly created QuicChannel.
QuicServerCodecBuilder	clone()	Clone the builder
QuicServerCodecBuilder	connectionIdAddressGenerator(QuicConnectionIdGenerator connectionIdAddressGenerator)	Sets the QuicConnectionIdGenerator to use.
QuicServerCodecBuilder	handler(ChannelHandler handler)	Set the ChannelHandler that is added to the ChannelPipeline of the QuicChannel once created.
<T> QuicServerCodecBuilder	option(ChannelOption<T> option, T value)	Allow to specify a ChannelOption which is used for the QuicChannel instances once they got created.
QuicServerCodecBuilder	resetTokenGenerator(@Nullable QuicResetTokenGenerator resetTokenGenerator)	Set the QuicResetTokenGenerator that is used to generate stateless reset tokens or null if the default should be used.
<T> QuicServerCodecBuilder	streamAttr(AttributeKey<T> key, T value)	Allow to specify an initial attribute of the newly created QuicStreamChannel.
QuicServerCodecBuilder	streamHandler(ChannelHandler streamHandler)	Set the ChannelHandler that is added to the ChannelPipeline of the QuicStreamChannel once created.
<T> QuicServerCodecBuilder	streamOption(ChannelOption<T> option, T value)	Allow to specify a ChannelOption which is used for the QuicStreamChannel instances once they got created.
QuicServerCodecBuilder	tokenHandler(@Nullable QuicTokenHandler tokenHandler)	Set the QuicTokenHandler that is used to generate and validate tokens or null if no tokens should be used at all.
protected void	validate()	Validate the configuration before building the codec.

Methods inherited from class QuicCodecBuilder

ackDelayExponent, activeConnectionIdLimit, activeMigration, build, congestionControlAlgorithm, datagram, discoverPmtu, flushStrategy, grease, hystart, initialCongestionWindowPackets, initialMaxData, initialMaxStreamDataBidirectionalLocal, initialMaxStreamDataBidirectionalRemote, initialMaxStreamDataUnidirectional, initialMaxStreamsBidirectional, initialMaxStreamsUnidirectional, localConnectionIdLength, maxAckDelay, maxIdleTimeout, maxRecvUdpPayloadSize, maxSendUdpPayloadSize, self, sslContext, sslEngineProvider, sslTaskExecutor, statelessResetToken, version

Modifier and Type	Method	Description
final QuicServerCodecBuilder	ackDelayExponent(long value)	See set_ack_delay_exponent.
final QuicServerCodecBuilder	activeConnectionIdLimit(long limit)	Allows to configure the active connect id limit that should be used.
final QuicServerCodecBuilder	activeMigration(boolean enable)	See set_disable_active_migration.
final ChannelHandler	build()	Builds the QUIC codec that should be added to the ChannelPipeline of the underlying Channel which is used as transport for QUIC.
final QuicServerCodecBuilder	congestionControlAlgorithm(QuicCongestionControlAlgorithm congestionControlAlgorithm)	Sets the congestion control algorithm to use.
final QuicServerCodecBuilder	datagram(int recvQueueLen, int sendQueueLen)	If configured this will enable Datagram support.
final QuicServerCodecBuilder	discoverPmtu(boolean enable)	See discover_pmtu.
final QuicServerCodecBuilder	flushStrategy(FlushStrategy flushStrategy)	Sets the FlushStrategy that will be used to detect when an automatic flush should happen.
final QuicServerCodecBuilder	grease(boolean enable)	Set if greasing should be enabled or not.
final QuicServerCodecBuilder	hystart(boolean enable)	See enable_hystart.
final QuicServerCodecBuilder	initialCongestionWindowPackets(int numPackets)	Sets initial congestion window size in terms of packet count.
final QuicServerCodecBuilder	initialMaxData(long value)	See set_initial_max_data.
final QuicServerCodecBuilder	initialMaxStreamDataBidirectionalLocal(long value)	See set_initial_max_stream_data_bidi_local.
final QuicServerCodecBuilder	initialMaxStreamDataBidirectionalRemote(long value)	See set_initial_max_stream_data_bidi_remote.
final QuicServerCodecBuilder	initialMaxStreamDataUnidirectional(long value)	See set_initial_max_stream_data_uni.
final QuicServerCodecBuilder	initialMaxStreamsBidirectional(long value)	See set_initial_max_streams_bidi.
final QuicServerCodecBuilder	initialMaxStreamsUnidirectional(long value)	See set_initial_max_streams_uni.
final QuicServerCodecBuilder	localConnectionIdLength(int value)	Sets the local connection id length that is used.
final QuicServerCodecBuilder	maxAckDelay(long amount, TimeUnit unit)	See set_max_ack_delay.
final QuicServerCodecBuilder	maxIdleTimeout(long amount, TimeUnit unit)	See set_max_idle_timeout.
final QuicServerCodecBuilder	maxRecvUdpPayloadSize(long size)	See set_max_recv_udp_payload_size.
final QuicServerCodecBuilder	maxSendUdpPayloadSize(long size)	See set_max_send_udp_payload_size.
protected final QuicServerCodecBuilder	self()	Returns itself.
final QuicServerCodecBuilder	sslContext(QuicSslContext sslContext)	The QuicSslContext that will be used to create QuicSslEngines for QuicChannels.
final QuicServerCodecBuilder	sslEngineProvider(Function<QuicChannel, ? extends QuicSslEngine> sslEngineProvider)	The Function that will return the QuicSslEngine that should be used for the QuicChannel.
final QuicServerCodecBuilder	sslTaskExecutor(Executor sslTaskExecutor)	Allow to configure a Executor that will be used to run expensive SSL operations.
final QuicServerCodecBuilder	statelessResetToken(byte[] token)	Allows to configure the active connect id limit that should be used.
final QuicServerCodecBuilder	version(int version)	Allows to configure the QUIC version that should be used.

Methods inherited from class Object

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

Constructor Details

QuicServerCodecBuilder

public QuicServerCodecBuilder()

Creates a new instance.

Method Details

clone

public QuicServerCodecBuilder clone()

Description copied from class: QuicCodecBuilder

Clone the builder

Specified by:

clone in class QuicCodecBuilder<QuicServerCodecBuilder>

Returns:

the new instance that is a clone if this instance.

option

public <T> QuicServerCodecBuilder option(ChannelOption<T> option,
 @Nullable
 T value)

Allow to specify a ChannelOption which is used for the QuicChannel instances once they got created. Use a value of null to remove a previous set ChannelOption.

Type Parameters:

T - the type of the value.

Parameters:

option - the ChannelOption to apply to the QuicChannel.

value - the value of the option.

Returns:

this instance.

attr

public <T> QuicServerCodecBuilder attr(AttributeKey<T> key,
 @Nullable
 T value)

Allow to specify an initial attribute of the newly created QuicChannel. If the value is null, the attribute of the specified key is removed.

Type Parameters:

T - the type of the value.

Parameters:

key - the AttributeKey to apply to the QuicChannel.

value - the value of the attribute.

Returns:

this instance.

handler

public QuicServerCodecBuilder handler(ChannelHandler handler)

Set the ChannelHandler that is added to the ChannelPipeline of the QuicChannel once created.

Parameters:

handler - the ChannelHandler that is added to the QuicChannels ChannelPipeline.

Returns:

this instance.

streamOption

public <T> QuicServerCodecBuilder streamOption(ChannelOption<T> option,
 @Nullable
 T value)

Allow to specify a ChannelOption which is used for the QuicStreamChannel instances once they got created. Use a value of null to remove a previous set ChannelOption.

Type Parameters:

T - the type of the value.

Parameters:

option - the ChannelOption to apply to the QuicStreamChannels.

value - the value of the option.

Returns:

this instance.

streamAttr

public <T> QuicServerCodecBuilder streamAttr(AttributeKey<T> key,
 @Nullable
 T value)

Allow to specify an initial attribute of the newly created QuicStreamChannel. If the value is null, the attribute of the specified key is removed.

Type Parameters:

T - the type of the value.

Parameters:

key - the AttributeKey to apply to the QuicStreamChannels.

value - the value of the attribute.

Returns:

this instance.

streamHandler

public QuicServerCodecBuilder streamHandler(ChannelHandler streamHandler)

Set the ChannelHandler that is added to the ChannelPipeline of the QuicStreamChannel once created.

Parameters:

streamHandler - the ChannelHandler that is added to the QuicStreamChannels ChannelPipeline.

Returns:

this instance.

connectionIdAddressGenerator

public QuicServerCodecBuilder connectionIdAddressGenerator(QuicConnectionIdGenerator connectionIdAddressGenerator)

Sets the QuicConnectionIdGenerator to use.

Parameters:

connectionIdAddressGenerator - the QuicConnectionIdGenerator to use.

Returns:

this instance.

tokenHandler

public QuicServerCodecBuilder tokenHandler(@Nullable
 @Nullable QuicTokenHandler tokenHandler)

Set the QuicTokenHandler that is used to generate and validate tokens or null if no tokens should be used at all.

Parameters:

tokenHandler - the QuicTokenHandler to use.

Returns:

this instance.

resetTokenGenerator

public QuicServerCodecBuilder resetTokenGenerator(@Nullable
 @Nullable QuicResetTokenGenerator resetTokenGenerator)

Set the QuicResetTokenGenerator that is used to generate stateless reset tokens or null if the default should be used.

Parameters:

resetTokenGenerator - the QuicResetTokenGenerator to use.

Returns:

this instance.

validate

protected void validate()

Description copied from class: QuicCodecBuilder

Validate the configuration before building the codec.

Overrides:

validate in class QuicCodecBuilder<QuicServerCodecBuilder>