io.netty.incubator.codec.quic

Class QuicChannelBootstrap

java.lang.Object

io.netty.incubator.codec.quic.QuicChannelBootstrap

public final class QuicChannelBootstrap
extends Object

Bootstrap that helps to bootstrap QuicChannels and connecting these to remote peers.

Constructor Summary

Constructors

Constructor and Description
QuicChannelBootstrap(io.netty.channel.Channel parent) Deprecated. Use QuicChannel.newBootstrap() instead.

Method Summary

Modifier and Type	Method and Description
<T> QuicChannelBootstrap	attr(io.netty.util.AttributeKey<T> key, T value) Allow to specify an initial attribute of the newly created QuicChannel.
io.netty.util.concurrent.Future<QuicChannel>	connect() Connects a QuicChannel to the remote peer and notifies the future once done.
io.netty.util.concurrent.Future<QuicChannel>	connect(io.netty.util.concurrent.Promise<QuicChannel> promise) Connects a QuicChannel to the remote peer and notifies the promise once done.
QuicChannelBootstrap	connectionAddress(QuicConnectionAddress connectionAddress) Deprecated. use localConnectionAddress(QuicConnectionAddress).
QuicChannelBootstrap	handler(io.netty.channel.ChannelHandler handler) Set the ChannelHandler that is added to the ChannelPipeline of the QuicChannel once created.
QuicChannelBootstrap	localAddress(SocketAddress local) Set the local address.
QuicChannelBootstrap	localConnectionAddress(QuicConnectionAddress localConnectionAddress) Set the QuicConnectionAddress to use.
<T> QuicChannelBootstrap	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.
QuicChannelBootstrap	remoteAddress(SocketAddress remote) Set the remote address of the host to talk to.
QuicChannelBootstrap	remoteConnectionAddress(QuicConnectionAddress remoteConnectionAddress) Set the QuicConnectionAddress to use.
<T> QuicChannelBootstrap	streamAttr(io.netty.util.AttributeKey<T> key, T value) Allow to specify an initial attribute of the newly created QuicStreamChannel.
QuicChannelBootstrap	streamHandler(io.netty.channel.ChannelHandler streamHandler) Set the ChannelHandler that is added to the ChannelPipeline of the QuicStreamChannel once created.
<T> QuicChannelBootstrap	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

QuicChannelBootstrap

@Deprecated
public QuicChannelBootstrap(io.netty.channel.Channel parent)

Deprecated. Use QuicChannel.newBootstrap() instead.

Creates a new instance which uses the given Channel to bootstrap the QuicChannel. This ChannelPipeline of the Channel needs to have the quic codec in the pipeline.

Parameters:

parent - the Channel that is used as the transport layer.

Method Detail

option

public <T> QuicChannelBootstrap option(io.netty.channel.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> QuicChannelBootstrap attr(io.netty.util.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 QuicChannelBootstrap 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> QuicChannelBootstrap streamOption(io.netty.channel.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> QuicChannelBootstrap streamAttr(io.netty.util.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 QuicChannelBootstrap 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.

localAddress

public QuicChannelBootstrap localAddress(SocketAddress local)

Set the local address.

Parameters:

local - the SocketAddress of the local peer.

Returns:

this instance.

remoteAddress

public QuicChannelBootstrap remoteAddress(SocketAddress remote)

Set the remote address of the host to talk to.

Parameters:

remote - the SocketAddress of the remote peer.

Returns:

this instance.

connectionAddress

@Deprecated
public QuicChannelBootstrap connectionAddress(QuicConnectionAddress connectionAddress)

Deprecated. use localConnectionAddress(QuicConnectionAddress).

Set the QuicConnectionAddress to use. If none is specified a random address is generated on your behalf.

Parameters:

connectionAddress - the QuicConnectionAddress to use.

Returns:

this instance.

localConnectionAddress

public QuicChannelBootstrap localConnectionAddress(QuicConnectionAddress localConnectionAddress)

Set the QuicConnectionAddress to use. If none is specified a random address is generated on your behalf.

Parameters:

localConnectionAddress - the QuicConnectionAddress to use.

Returns:

this instance.

remoteConnectionAddress

public QuicChannelBootstrap remoteConnectionAddress(QuicConnectionAddress remoteConnectionAddress)

Set the QuicConnectionAddress to use. If none is specified a random address is generated on your behalf. Be aware that the provided QuicConnectionAddress should be generated carefully in a random way that makes it impossible to predict it as otherwise the security of the quic connection might be too weak. Fore more details see RFC9000 Section 7.2.

Parameters:

remoteConnectionAddress - the QuicConnectionAddress to use.

Returns:

this instance.

connect

public io.netty.util.concurrent.Future<QuicChannel> connect()

Connects a QuicChannel to the remote peer and notifies the future once done.

Returns:

Future which is notified once the operation completes.

connect

public io.netty.util.concurrent.Future<QuicChannel> connect(io.netty.util.concurrent.Promise<QuicChannel> promise)

Connects a QuicChannel to the remote peer and notifies the promise once done.

Parameters:

promise - the Promise which is notified once the operations completes.

Returns:

Future which is notified once the operation completes.