Package io.netty.handler.codec.quic

Interface QuicStreamChannel

All Superinterfaces:

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

public interface QuicStreamChannel
extends DuplexChannel

A QUIC stream.

Nested Class Summary

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

Channel.Unsafe

Field Summary

Fields

Modifier and Type	Field	Description
static ChannelFutureListener	SHUTDOWN_OUTPUT	Should be added to a ChannelFuture when the output should be cleanly shutdown via a FIN.

Method Summary

Modifier and Type	Method	Description
default ChannelFuture	bind(java.net.SocketAddress socketAddress)	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 channelPromise)	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(ChannelPromise channelPromise)	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
QuicStreamChannelConfig	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 channelPromise)	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 channelPromise)	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	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 channelPromise)	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 channelPromise)	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.
QuicStreamChannel	flush()	Request to flush all pending messages via this ChannelOutboundInvoker.
boolean	isLocalCreated()	Returns true if the stream was created locally.
QuicStreamAddress	localAddress()	Returns the local address where this channel is bound to.
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 ChannelFuture	newSucceededFuture()	Create a new ChannelFuture which is marked as succeeded already.
QuicChannel	parent()	Returns the parent of this channel.
@Nullable QuicStreamPriority	priority()	The QuicStreamPriority if explicit set for the stream via updatePriority(QuicStreamPriority) or updatePriority(QuicStreamPriority, ChannelPromise).
QuicStreamChannel	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.
QuicStreamAddress	remoteAddress()	Returns the remote address where this channel is connected to.
default ChannelFuture	shutdown()	Will shutdown the input and output sides of this channel.
default ChannelFuture	shutdown(int error)	Shortcut for calling shutdownInput(int) and shutdownInput(int).
ChannelFuture	shutdown(int error, ChannelPromise promise)	Shortcut for calling shutdownInput(int, ChannelPromise) and shutdownInput(int, ChannelPromise).
default ChannelFuture	shutdownInput()
default ChannelFuture	shutdownInput(int error)	Shutdown the input of the stream with the given error code.
ChannelFuture	shutdownInput(int error, ChannelPromise promise)	Shutdown the input of the stream with the given error code.
default ChannelFuture	shutdownInput(ChannelPromise promise)	Will shutdown the input and notify ChannelPromise.
default ChannelFuture	shutdownOutput()
default ChannelFuture	shutdownOutput(int error)	Shutdown the output of the stream with the given error code.
ChannelFuture	shutdownOutput(int error, ChannelPromise promise)	Shutdown the output of the stream with the given error code.
long	streamId()	The id of the stream.
QuicStreamType	type()	Returns the QuicStreamType of the stream.
default ChannelFuture	updatePriority(QuicStreamPriority priority)	Update the priority of the stream.
ChannelFuture	updatePriority(QuicStreamPriority priority, ChannelPromise promise)	Update the priority of the stream.
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 channelPromise)	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 channelPromise)	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, pipeline, setOption, unsafe

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface io.netty.channel.socket.DuplexChannel

isInputShutdown, isOutputShutdown, isShutdown, shutdown, shutdownOutput

Field Detail

SHUTDOWN_OUTPUT

static final ChannelFutureListener SHUTDOWN_OUTPUT

Should be added to a ChannelFuture when the output should be cleanly shutdown via a FIN. No more writes will be allowed after this point.

Method Detail

bind

default ChannelFuture bind(java.net.SocketAddress socketAddress)

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 channelPromise)

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 channelPromise)

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 channelPromise)

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 channelPromise)

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 channelPromise)

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 channelPromise)

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 channelPromise)

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 channelPromise)

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

shutdownInput

default ChannelFuture shutdownInput()

Specified by:

shutdownInput in interface DuplexChannel

See Also:

Socket.shutdownInput()

shutdownInput

default ChannelFuture shutdownInput(ChannelPromise promise)

Description copied from interface: DuplexChannel

Will shutdown the input and notify ChannelPromise.

Specified by:

shutdownInput in interface DuplexChannel

See Also:

Socket.shutdownInput()

shutdownOutput

default ChannelFuture shutdownOutput()

Specified by:

shutdownOutput in interface DuplexChannel

See Also:

Socket.shutdownOutput()

shutdown

default ChannelFuture shutdown()

Description copied from interface: DuplexChannel

Will shutdown the input and output sides of this channel.

Specified by:

shutdown in interface DuplexChannel

Returns:

will be completed when both shutdown operations complete.

shutdown

default ChannelFuture shutdown(int error)

Shortcut for calling shutdownInput(int) and shutdownInput(int).

Parameters:

error - the error to send.

Returns:

the future that is notified on completion.

shutdown

ChannelFuture shutdown(int error,
                       ChannelPromise promise)

Shortcut for calling shutdownInput(int, ChannelPromise) and shutdownInput(int, ChannelPromise).

Parameters:

error - the error to send.

promise - will be notified on completion.

Returns:

the future that is notified on completion.

shutdownInput

default ChannelFuture shutdownInput(int error)

Shutdown the input of the stream with the given error code. This means a STOP_SENDING frame will be send to the remote peer and all data received will be discarded.

Parameters:

error - the error to send as part of the STOP_SENDING frame.

Returns:

the future that is notified on completion.

shutdownInput

ChannelFuture shutdownInput(int error,
                            ChannelPromise promise)

Shutdown the input of the stream with the given error code. This means a STOP_SENDING frame will be send to the remote peer and all data received will be discarded.

Parameters:

error - the error to send as part of the STOP_SENDING frame.

promise - will be notified on completion.

Returns:

the future that is notified on completion.

shutdownOutput

default ChannelFuture shutdownOutput(int error)

Shutdown the output of the stream with the given error code. This means a RESET_STREAM frame will be send to the remote peer and all data that is not sent yet will be discarded. Important:If you want to shutdown the output without sending a RESET_STREAM frame you should use shutdownOutput() which will shutdown the output by sending a FIN and so signal a clean shutdown.

Parameters:

error - the error to send as part of the RESET_STREAM frame.

Returns:

the future that is notified on completion.

shutdownOutput

ChannelFuture shutdownOutput(int error,
                             ChannelPromise promise)

Shutdown the output of the stream with the given error code. This means a RESET_STREAM frame will be send to the remote peer and all data that is not sent yet will be discarded. Important:If you want to shutdown the output without sending a RESET_STREAM frame you should use DuplexChannel.shutdownOutput(ChannelPromise) which will shutdown the output by sending a FIN and so signal a clean shutdown.

Parameters:

error - the error to send as part of the RESET_STREAM frame.

promise - will be notified on completion.

Returns:

the future that is notified on completion.

localAddress

QuicStreamAddress localAddress()

Description copied from interface: Channel

Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Specified by:

localAddress in interface Channel

Returns:

the local address of this channel. null if this channel is not bound.

remoteAddress

QuicStreamAddress remoteAddress()

Description copied from interface: Channel

Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Specified by:

remoteAddress in interface Channel

Returns:

the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.

isLocalCreated

boolean isLocalCreated()

Returns true if the stream was created locally.

Returns:

true if created locally, false otherwise.

type

QuicStreamType type()

Returns the QuicStreamType of the stream.

Returns:

QuicStreamType of this stream.

streamId

long streamId()

The id of the stream.

Returns:

the stream id of this QuicStreamChannel.

priority

@Nullable
@Nullable QuicStreamPriority priority()

The QuicStreamPriority if explicit set for the stream via updatePriority(QuicStreamPriority) or updatePriority(QuicStreamPriority, ChannelPromise). Otherwise null.

Returns:

the priority if any was set.

updatePriority

default ChannelFuture updatePriority(QuicStreamPriority priority)

Update the priority of the stream. A stream's priority determines the order in which stream data is sent on the wire (streams with lower priority are sent first).

Parameters:

priority - the priority.

Returns:

future that is notified once the operation completes.

updatePriority

ChannelFuture updatePriority(QuicStreamPriority priority,
                             ChannelPromise promise)

Update the priority of the stream. A stream's priority determines the order in which stream data is sent on the wire (streams with lower priority are sent first).

Parameters:

priority - the priority.

promise - notified once operations completes.

Returns:

future that is notified once the operation completes.

parent

QuicChannel parent()

Description copied from interface: Channel

Returns the parent of this channel.

Specified by:

parent in interface Channel

Returns:

the parent channel. null if this channel does not have a parent channel.

read

QuicStreamChannel 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

QuicStreamChannel 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

QuicStreamChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel