Package io.netty.handler.codec.quic

Interface QuicChannel

All Superinterfaces:

AttributeMap, Channel, ChannelOutboundInvoker, java.lang.Comparable<Channel>

public interface QuicChannel
extends Channel

A QUIC Channel.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Channel.Unsafe

Method Summary

Modifier and Type	Method	Description
default ChannelFuture	bind(java.net.SocketAddress localAddress)	Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	bind(java.net.SocketAddress localAddress, ChannelPromise promise)	Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	close()	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	close(boolean applicationClose, int error, ByteBuf reason)	Close the QuicChannel
ChannelFuture	close(boolean applicationClose, int error, ByteBuf reason, ChannelPromise promise)	Close the QuicChannel
default ChannelFuture	close(ChannelPromise promise)	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default Future<QuicConnectionPathStats>	collectPathStats(int pathIdx)	Collects statistics about the path of the connection and notifies the Future once done.
Future<QuicConnectionPathStats>	collectPathStats(int pathIdx, Promise<QuicConnectionPathStats> promise)	Collects statistics about the path of the connection and notifies the Promise once done.
default Future<QuicConnectionStats>	collectStats()	Collects statistics about the connection and notifies the Future once done.
Future<QuicConnectionStats>	collectStats(Promise<QuicConnectionStats> promise)	Collects statistics about the connection and notifies the Promise once done.
QuicChannelConfig	config()	Returns the configuration of this channel.
default ChannelFuture	connect(java.net.SocketAddress remoteAddress)	Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	connect(java.net.SocketAddress remoteAddress, ChannelPromise promise)	Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)	Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)	Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default Future<QuicStreamChannel>	createStream(QuicStreamType type, @Nullable ChannelHandler handler)	Creates a stream that is using this QuicChannel and notifies the Future once done.
Future<QuicStreamChannel>	createStream(QuicStreamType type, @Nullable ChannelHandler handler, Promise<QuicStreamChannel> promise)	Creates a stream that is using this QuicChannel and notifies the Promise once done.
default ChannelFuture	deregister()	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	deregister(ChannelPromise promise)	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	disconnect()	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	disconnect(ChannelPromise promise)	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
QuicChannel	flush()	Request to flush all pending messages via this ChannelOutboundInvoker.
boolean	isTimedOut()	Returns true if the connection was closed because of idle timeout.
@Nullable QuicConnectionAddress	localAddress()	Returns the local QuicConnectionAddress.
@Nullable java.net.SocketAddress	localSocketAddress()	Returns the local SocketAddress of the underlying transport that received the data.
static QuicChannelBootstrap	newBootstrap(Channel channel)	Creates a new QuicChannelBootstrap that can be used to create and connect new QuicChannels to endpoints using the given Channel as transport layer.
default ChannelFuture	newFailedFuture(java.lang.Throwable cause)	Create a new ChannelFuture which is marked as failed already.
default ChannelProgressivePromise	newProgressivePromise()	Return an new ChannelProgressivePromise
default ChannelPromise	newPromise()	Return a new ChannelPromise.
default QuicStreamChannelBootstrap	newStreamBootstrap()	Returns a new QuicStreamChannelBootstrap which makes it easy to bootstrap new QuicStreamChannels with custom options and attributes.
default ChannelFuture	newSucceededFuture()	Create a new ChannelFuture which is marked as succeeded already.
long	peerAllowedStreams(QuicStreamType type)	Returns the number of streams that can be created before stream creation will fail with QuicTransportError.STREAM_LIMIT_ERROR error.
@Nullable QuicTransportParameters	peerTransportParameters()	Returns the QuicTransportParameters of the peer once received, or null if not known yet.
QuicChannel	read()	Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading.
@Nullable QuicConnectionAddress	remoteAddress()	Returns the remote QuicConnectionAddress.
@Nullable java.net.SocketAddress	remoteSocketAddress()	Returns the remote SocketAddress of the underlying transport to which the data is sent.
@Nullable javax.net.ssl.SSLEngine	sslEngine()	Returns the used SSLEngine or null if none is used (yet).
default ChannelPromise	voidPromise()	Return a special ChannelPromise which can be reused for different operations.
default ChannelFuture	write(java.lang.Object msg)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
default ChannelFuture	write(java.lang.Object msg, ChannelPromise promise)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
default ChannelFuture	writeAndFlush(java.lang.Object msg)	Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
default ChannelFuture	writeAndFlush(java.lang.Object msg, ChannelPromise promise)	Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty.channel.Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, getOption, id, isActive, isOpen, isRegistered, isWritable, metadata, parent, pipeline, setOption, unsafe

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

bind

default ChannelFuture bind(java.net.SocketAddress localAddress)

Description copied from interface: ChannelOutboundInvoker

Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

bind in interface Channel

Specified by:

bind in interface ChannelOutboundInvoker

connect

default ChannelFuture connect(java.net.SocketAddress remoteAddress)

Description copied from interface: ChannelOutboundInvoker

Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.

This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

connect in interface Channel

Specified by:

connect in interface ChannelOutboundInvoker

connect

default ChannelFuture connect(java.net.SocketAddress remoteAddress,
                              java.net.SocketAddress localAddress)

Description copied from interface: ChannelOutboundInvoker

Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

connect in interface Channel

Specified by:

connect in interface ChannelOutboundInvoker

disconnect

default ChannelFuture disconnect()

Description copied from interface: ChannelOutboundInvoker

Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

disconnect in interface Channel

Specified by:

disconnect in interface ChannelOutboundInvoker

close

default ChannelFuture close()

Description copied from interface: ChannelOutboundInvoker

Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again.

This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

close in interface Channel

Specified by:

close in interface ChannelOutboundInvoker

deregister

default ChannelFuture deregister()

Description copied from interface: ChannelOutboundInvoker

Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

deregister in interface Channel

Specified by:

deregister in interface ChannelOutboundInvoker

bind

default ChannelFuture bind(java.net.SocketAddress localAddress,
                           ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.

This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

bind in interface Channel

Specified by:

bind in interface ChannelOutboundInvoker

connect

default ChannelFuture connect(java.net.SocketAddress remoteAddress,
                              ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelFuture will be notified.

If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.

This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

connect in interface Channel

Specified by:

connect in interface ChannelOutboundInvoker

connect

default ChannelFuture connect(java.net.SocketAddress remoteAddress,
                              java.net.SocketAddress localAddress,
                              ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified and also returned.

This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

connect in interface Channel

Specified by:

connect in interface ChannelOutboundInvoker

disconnect

default ChannelFuture disconnect(ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.

This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

disconnect in interface Channel

Specified by:

disconnect in interface ChannelOutboundInvoker

close

default ChannelFuture close(ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again. The given ChannelPromise will be notified.

This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

close in interface Channel

Specified by:

close in interface ChannelOutboundInvoker

deregister

default ChannelFuture deregister(ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.

This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

deregister in interface Channel

Specified by:

deregister in interface ChannelOutboundInvoker

write

default ChannelFuture write(java.lang.Object msg)

Description copied from interface: ChannelOutboundInvoker

Request to write a message via this ChannelHandlerContext through the ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelOutboundInvoker.flush() once you want to request to flush all pending data to the actual transport.

Specified by:

write in interface Channel

Specified by:

write in interface ChannelOutboundInvoker

write

default ChannelFuture write(java.lang.Object msg,
                            ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

Request to write a message via this ChannelHandlerContext through the ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelOutboundInvoker.flush() once you want to request to flush all pending data to the actual transport.

Specified by:

write in interface Channel

Specified by:

write in interface ChannelOutboundInvoker

writeAndFlush

default ChannelFuture writeAndFlush(java.lang.Object msg,
                                    ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

Specified by:

writeAndFlush in interface Channel

Specified by:

writeAndFlush in interface ChannelOutboundInvoker

writeAndFlush

default ChannelFuture writeAndFlush(java.lang.Object msg)

Description copied from interface: ChannelOutboundInvoker

Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().

Specified by:

writeAndFlush in interface Channel

Specified by:

writeAndFlush in interface ChannelOutboundInvoker

newPromise

default ChannelPromise newPromise()

Description copied from interface: ChannelOutboundInvoker

Return a new ChannelPromise.

Specified by:

newPromise in interface Channel

Specified by:

newPromise in interface ChannelOutboundInvoker

newProgressivePromise

default ChannelProgressivePromise newProgressivePromise()

Description copied from interface: ChannelOutboundInvoker

Return an new ChannelProgressivePromise

Specified by:

newProgressivePromise in interface Channel

Specified by:

newProgressivePromise in interface ChannelOutboundInvoker

newSucceededFuture

default ChannelFuture newSucceededFuture()

Description copied from interface: ChannelOutboundInvoker

Create a new ChannelFuture which is marked as succeeded already. So Future.isSuccess() will return true. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

Specified by:

newSucceededFuture in interface Channel

Specified by:

newSucceededFuture in interface ChannelOutboundInvoker

newFailedFuture

default ChannelFuture newFailedFuture(java.lang.Throwable cause)

Description copied from interface: ChannelOutboundInvoker

Create a new ChannelFuture which is marked as failed already. So Future.isSuccess() will return false. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

Specified by:

newFailedFuture in interface Channel

Specified by:

newFailedFuture in interface ChannelOutboundInvoker

voidPromise

default ChannelPromise voidPromise()

Description copied from interface: ChannelOutboundInvoker

Return a special ChannelPromise which can be reused for different operations.

It's only supported to use it for ChannelOutboundInvoker.write(Object, ChannelPromise).

Be aware that the returned ChannelPromise will not support most operations and should only be used if you want to save an object allocation for every write operation. You will not be able to detect if the operation was complete, only if it failed as the implementation will call ChannelPipeline.fireExceptionCaught(Throwable) in this case.

Be aware this is an expert feature and should be used with care!

Specified by:

voidPromise in interface Channel

Specified by:

voidPromise in interface ChannelOutboundInvoker

read

QuicChannel read()

Description copied from interface: ChannelOutboundInvoker

Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading. If there's a pending read operation already, this method does nothing.

This will result in having the ChannelOutboundHandler.read(ChannelHandlerContext) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

read in interface Channel

Specified by:

read in interface ChannelOutboundInvoker

flush

QuicChannel flush()

Description copied from interface: ChannelOutboundInvoker

Request to flush all pending messages via this ChannelOutboundInvoker.

Specified by:

flush in interface Channel

Specified by:

flush in interface ChannelOutboundInvoker

config

QuicChannelConfig config()

Returns the configuration of this channel.

Specified by:

config in interface Channel

sslEngine

@Nullable
@Nullable javax.net.ssl.SSLEngine sslEngine()

Returns the used SSLEngine or null if none is used (yet).

Returns:

the engine.

peerAllowedStreams

long peerAllowedStreams(QuicStreamType type)

Returns the number of streams that can be created before stream creation will fail with QuicTransportError.STREAM_LIMIT_ERROR error.

Parameters:

type - the stream type.

Returns:

the number of streams left.

isTimedOut

boolean isTimedOut()

Returns true if the connection was closed because of idle timeout.

Returns:

true if the connection was closed because of idle timeout, false.

peerTransportParameters

@Nullable
@Nullable QuicTransportParameters peerTransportParameters()

Returns the QuicTransportParameters of the peer once received, or null if not known yet.

Returns:

peerTransportParams.

localAddress

@Nullable
@Nullable QuicConnectionAddress localAddress()

Returns the local QuicConnectionAddress. This address might change over the life-time of the channel.

Specified by:

localAddress in interface Channel

Returns:

local the local QuicConnectionAddress or null if none is assigned yet, or assigned anymore.

remoteAddress

@Nullable
@Nullable QuicConnectionAddress remoteAddress()

Returns the remote QuicConnectionAddress. This address might change over the life-time of the channel.

Specified by:

remoteAddress in interface Channel

Returns:

remote the remote QuicConnectionAddress or null if none is assigned yet, or assigned anymore.

localSocketAddress

@Nullable
@Nullable java.net.SocketAddress localSocketAddress()

Returns the local SocketAddress of the underlying transport that received the data. This address might change over the life-time of the channel.

Returns:

local the local SocketAddress of the underlying transport or null if none is assigned yet, or assigned anymore.

remoteSocketAddress

@Nullable
@Nullable java.net.SocketAddress remoteSocketAddress()

Returns the remote SocketAddress of the underlying transport to which the data is sent. This address might change over the life-time of the channel.

Returns:

local the remote SocketAddress of the underlying transport or null if none is assigned yet, or assigned anymore.

createStream

default Future<QuicStreamChannel> createStream(QuicStreamType type,
                                               @Nullable
                                               @Nullable ChannelHandler handler)

Creates a stream that is using this QuicChannel and notifies the Future once done. The ChannelHandler (if not null) is added to the ChannelPipeline of the QuicStreamChannel automatically.

Parameters:

type - the QuicStreamType of the QuicStreamChannel.

handler - the ChannelHandler that will be added to the QuicStreamChannels ChannelPipeline during the stream creation.

Returns:

the Future that will be notified once the operation completes.

createStream

Future<QuicStreamChannel> createStream(QuicStreamType type,
                                       @Nullable
                                       @Nullable ChannelHandler handler,
                                       Promise<QuicStreamChannel> promise)

Creates a stream that is using this QuicChannel and notifies the Promise once done. The ChannelHandler (if not null) is added to the ChannelPipeline of the QuicStreamChannel automatically.

Parameters:

type - the QuicStreamType of the QuicStreamChannel.

handler - the ChannelHandler that will be added to the QuicStreamChannels ChannelPipeline during the stream creation.

promise - the ChannelPromise that will be notified once the operation completes.

Returns:

the Future that will be notified once the operation completes.

newStreamBootstrap

default QuicStreamChannelBootstrap newStreamBootstrap()

Returns a new QuicStreamChannelBootstrap which makes it easy to bootstrap new QuicStreamChannels with custom options and attributes. For simpler use-cases you may want to consider using createStream(QuicStreamType, ChannelHandler) or createStream(QuicStreamType, ChannelHandler, Promise) directly.

Returns:

QuicStreamChannelBootstrap that can be used to bootstrap a QuicStreamChannel.

close

default ChannelFuture close(boolean applicationClose,
                            int error,
                            ByteBuf reason)

Close the QuicChannel

Parameters:

applicationClose - true if an application close should be used, false if a normal close should be used.

error - the application error number, or 0 if no special error should be signaled.

reason - the reason for the closure (which may be an empty ByteBuf.

Returns:

the future that is notified.

close

ChannelFuture close(boolean applicationClose,
                    int error,
                    ByteBuf reason,
                    ChannelPromise promise)

Close the QuicChannel

Parameters:

applicationClose - true if an application close should be used, false if a normal close should be used.

error - the application error number, or 0 if no special error should be signaled.

reason - the reason for the closure (which may be an empty ByteBuf.

promise - the ChannelPromise that will be notified.

Returns:

the future that is notified.

collectStats

default Future<QuicConnectionStats> collectStats()

Collects statistics about the connection and notifies the Future once done.

Returns:

the Future that is notified once the stats were collected.

collectStats

Future<QuicConnectionStats> collectStats(Promise<QuicConnectionStats> promise)

Collects statistics about the connection and notifies the Promise once done.

Parameters:

promise - the ChannelPromise that is notified once the stats were collected.

Returns:

the Future that is notified once the stats were collected.

collectPathStats

default Future<QuicConnectionPathStats> collectPathStats(int pathIdx)

Collects statistics about the path of the connection and notifies the Future once done.

Returns:

the Future that is notified once the stats were collected.

collectPathStats

Future<QuicConnectionPathStats> collectPathStats(int pathIdx,
                                                 Promise<QuicConnectionPathStats> promise)

Collects statistics about the path of the connection and notifies the Promise once done.

Parameters:

promise - the ChannelPromise that is notified once the stats were collected.

Returns:

the Future that is notified once the stats were collected.

newBootstrap

static QuicChannelBootstrap newBootstrap(Channel channel)

Creates a new QuicChannelBootstrap that can be used to create and connect new QuicChannels to endpoints using the given Channel as transport layer.

Parameters:

channel - the Channel that is used as transport layer.

Returns:

QuicChannelBootstrap that can be used to bootstrap a client side QuicChannel.