io.netty.incubator.codec.quic

Class QuicServerCodecBuilder

java.lang.Object

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

io.netty.incubator.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 and Description
QuicServerCodecBuilder() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
<T> QuicServerCodecBuilder	attr(io.netty.util.AttributeKey<T> key, T value) Allow to specify an initial attribute of the newly created QuicChannel.
protected io.netty.channel.ChannelHandler	build(io.netty.incubator.codec.quic.QuicheConfig config, java.util.function.Function<QuicChannel,? extends QuicSslEngine> sslEngineProvider, java.util.concurrent.Executor sslTaskExecutor, int localConnIdLength, FlushStrategy flushStrategy) Builds the QUIC codec.
QuicServerCodecBuilder	clone() Clone the builder
QuicServerCodecBuilder	connectionIdAddressGenerator(QuicConnectionIdGenerator connectionIdAddressGenerator) Sets the QuicConnectionIdGenerator to use.
QuicServerCodecBuilder	handler(io.netty.channel.ChannelHandler handler) Set the ChannelHandler that is added to the ChannelPipeline of the QuicChannel once created.
<T> QuicServerCodecBuilder	option(io.netty.channel.ChannelOption<T> option, T value) Allow to specify a ChannelOption which is used for the QuicChannel instances once they got created.
QuicServerCodecBuilder	resetTokenGenerator(QuicResetTokenGenerator resetTokenGenerator) Set the QuicResetTokenGenerator that is used to generate stateless reset tokens or null if the default should be used.
<T> QuicServerCodecBuilder	streamAttr(io.netty.util.AttributeKey<T> key, T value) Allow to specify an initial attribute of the newly created QuicStreamChannel.
QuicServerCodecBuilder	streamHandler(io.netty.channel.ChannelHandler streamHandler) Set the ChannelHandler that is added to the ChannelPipeline of the QuicStreamChannel once created.
<T> QuicServerCodecBuilder	streamOption(io.netty.channel.ChannelOption<T> option, T value) Allow to specify a ChannelOption which is used for the QuicStreamChannel instances once they got created.
QuicServerCodecBuilder	tokenHandler(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 io.netty.incubator.codec.quic.QuicCodecBuilder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

QuicServerCodecBuilder

public QuicServerCodecBuilder()

Creates a new instance.

Method Detail

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(io.netty.channel.ChannelOption<T> option,
                                         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(io.netty.util.AttributeKey<T> key,
                                       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(io.netty.channel.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(io.netty.channel.ChannelOption<T> option,
                                               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(io.netty.util.AttributeKey<T> key,
                                             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(io.netty.channel.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(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(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>

build

protected io.netty.channel.ChannelHandler build(io.netty.incubator.codec.quic.QuicheConfig config,
                                                java.util.function.Function<QuicChannel,? extends QuicSslEngine> sslEngineProvider,
                                                java.util.concurrent.Executor sslTaskExecutor,
                                                int localConnIdLength,
                                                FlushStrategy flushStrategy)

Description copied from class: QuicCodecBuilder

Builds the QUIC codec.

Specified by:

build in class QuicCodecBuilder<QuicServerCodecBuilder>

Parameters:

config - the QuicheConfig that should be used.

sslEngineProvider - the context provider

sslTaskExecutor - the Executor to use.

localConnIdLength - the local connection id length.

flushStrategy - the FlushStrategy that should be used.

Returns:

the ChannelHandler which acts as codec.