Package io.netty.handler.codec.quic

Interface QuicStreamChannel

All Superinterfaces:

io.netty.util.AttributeMap, io.netty.channel.Channel, io.netty.channel.ChannelOutboundInvoker, Comparable<io.netty.channel.Channel>, io.netty.channel.socket.DuplexChannel

public interface QuicStreamChannel
extends io.netty.channel.socket.DuplexChannel

A QUIC stream.

Nested Class Summary

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

io.netty.channel.Channel.Unsafe

Field Summary

Fields

Modifier and Type	Field	Description
static io.netty.channel.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 io.netty.channel.ChannelFuture	bind(SocketAddress socketAddress)
default io.netty.channel.ChannelFuture	bind(SocketAddress localAddress, io.netty.channel.ChannelPromise channelPromise)
default io.netty.channel.ChannelFuture	close()
default io.netty.channel.ChannelFuture	close(io.netty.channel.ChannelPromise channelPromise)
QuicStreamChannelConfig	config()
default io.netty.channel.ChannelFuture	connect(SocketAddress remoteAddress)
default io.netty.channel.ChannelFuture	connect(SocketAddress remoteAddress, io.netty.channel.ChannelPromise channelPromise)
default io.netty.channel.ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress)
default io.netty.channel.ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress, io.netty.channel.ChannelPromise channelPromise)
default io.netty.channel.ChannelFuture	deregister()
default io.netty.channel.ChannelFuture	deregister(io.netty.channel.ChannelPromise channelPromise)
default io.netty.channel.ChannelFuture	disconnect()
default io.netty.channel.ChannelFuture	disconnect(io.netty.channel.ChannelPromise channelPromise)
QuicStreamChannel	flush()
boolean	isLocalCreated()	Returns true if the stream was created locally.
QuicStreamAddress	localAddress()
default io.netty.channel.ChannelFuture	newFailedFuture(Throwable cause)
default io.netty.channel.ChannelProgressivePromise	newProgressivePromise()
default io.netty.channel.ChannelPromise	newPromise()
default io.netty.channel.ChannelFuture	newSucceededFuture()
QuicChannel	parent()
@Nullable QuicStreamPriority	priority()	The QuicStreamPriority if explicit set for the stream via updatePriority(QuicStreamPriority) or updatePriority(QuicStreamPriority, ChannelPromise).
QuicStreamChannel	read()
QuicStreamAddress	remoteAddress()
default io.netty.channel.ChannelFuture	shutdown()
default io.netty.channel.ChannelFuture	shutdown(int error)	Shortcut for calling shutdownInput(int) and shutdownInput(int).
io.netty.channel.ChannelFuture	shutdown(int error, io.netty.channel.ChannelPromise promise)	Shortcut for calling shutdownInput(int, ChannelPromise) and shutdownInput(int, ChannelPromise).
default io.netty.channel.ChannelFuture	shutdownInput()
default io.netty.channel.ChannelFuture	shutdownInput(int error)	Shutdown the input of the stream with the given error code.
io.netty.channel.ChannelFuture	shutdownInput(int error, io.netty.channel.ChannelPromise promise)	Shutdown the input of the stream with the given error code.
default io.netty.channel.ChannelFuture	shutdownInput(io.netty.channel.ChannelPromise promise)
default io.netty.channel.ChannelFuture	shutdownOutput()
default io.netty.channel.ChannelFuture	shutdownOutput(int error)	Shutdown the output of the stream with the given error code.
io.netty.channel.ChannelFuture	shutdownOutput(int error, io.netty.channel.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 io.netty.channel.ChannelFuture	updatePriority(QuicStreamPriority priority)	Update the priority of the stream.
io.netty.channel.ChannelFuture	updatePriority(QuicStreamPriority priority, io.netty.channel.ChannelPromise promise)	Update the priority of the stream.
default io.netty.channel.ChannelPromise	voidPromise()
default io.netty.channel.ChannelFuture	write(Object msg)
default io.netty.channel.ChannelFuture	write(Object msg, io.netty.channel.ChannelPromise channelPromise)
default io.netty.channel.ChannelFuture	writeAndFlush(Object msg)
default io.netty.channel.ChannelFuture	writeAndFlush(Object msg, io.netty.channel.ChannelPromise channelPromise)

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 io.netty.channel.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 io.netty.channel.ChannelFuture bind(SocketAddress socketAddress)

Specified by:

bind in interface io.netty.channel.Channel

Specified by:

bind in interface io.netty.channel.ChannelOutboundInvoker

connect

default io.netty.channel.ChannelFuture connect(SocketAddress remoteAddress)

Specified by:

connect in interface io.netty.channel.Channel

Specified by:

connect in interface io.netty.channel.ChannelOutboundInvoker

connect

default io.netty.channel.ChannelFuture connect(SocketAddress remoteAddress,
                                               SocketAddress localAddress)

Specified by:

connect in interface io.netty.channel.Channel

Specified by:

connect in interface io.netty.channel.ChannelOutboundInvoker

disconnect

default io.netty.channel.ChannelFuture disconnect()

Specified by:

disconnect in interface io.netty.channel.Channel

Specified by:

disconnect in interface io.netty.channel.ChannelOutboundInvoker

close

default io.netty.channel.ChannelFuture close()

Specified by:

close in interface io.netty.channel.Channel

Specified by:

close in interface io.netty.channel.ChannelOutboundInvoker

deregister

default io.netty.channel.ChannelFuture deregister()

Specified by:

deregister in interface io.netty.channel.Channel

Specified by:

deregister in interface io.netty.channel.ChannelOutboundInvoker

bind

default io.netty.channel.ChannelFuture bind(SocketAddress localAddress,
                                            io.netty.channel.ChannelPromise channelPromise)

Specified by:

bind in interface io.netty.channel.Channel

Specified by:

bind in interface io.netty.channel.ChannelOutboundInvoker

connect

default io.netty.channel.ChannelFuture connect(SocketAddress remoteAddress,
                                               io.netty.channel.ChannelPromise channelPromise)

Specified by:

connect in interface io.netty.channel.Channel

Specified by:

connect in interface io.netty.channel.ChannelOutboundInvoker

connect

default io.netty.channel.ChannelFuture connect(SocketAddress remoteAddress,
                                               SocketAddress localAddress,
                                               io.netty.channel.ChannelPromise channelPromise)

Specified by:

connect in interface io.netty.channel.Channel

Specified by:

connect in interface io.netty.channel.ChannelOutboundInvoker

disconnect

default io.netty.channel.ChannelFuture disconnect(io.netty.channel.ChannelPromise channelPromise)

Specified by:

disconnect in interface io.netty.channel.Channel

Specified by:

disconnect in interface io.netty.channel.ChannelOutboundInvoker

close

default io.netty.channel.ChannelFuture close(io.netty.channel.ChannelPromise channelPromise)

Specified by:

close in interface io.netty.channel.Channel

Specified by:

close in interface io.netty.channel.ChannelOutboundInvoker

deregister

default io.netty.channel.ChannelFuture deregister(io.netty.channel.ChannelPromise channelPromise)

Specified by:

deregister in interface io.netty.channel.Channel

Specified by:

deregister in interface io.netty.channel.ChannelOutboundInvoker

write

default io.netty.channel.ChannelFuture write(Object msg)

Specified by:

write in interface io.netty.channel.Channel

Specified by:

write in interface io.netty.channel.ChannelOutboundInvoker

write

default io.netty.channel.ChannelFuture write(Object msg,
                                             io.netty.channel.ChannelPromise channelPromise)

Specified by:

write in interface io.netty.channel.Channel

Specified by:

write in interface io.netty.channel.ChannelOutboundInvoker

writeAndFlush

default io.netty.channel.ChannelFuture writeAndFlush(Object msg,
                                                     io.netty.channel.ChannelPromise channelPromise)

Specified by:

writeAndFlush in interface io.netty.channel.Channel

Specified by:

writeAndFlush in interface io.netty.channel.ChannelOutboundInvoker

writeAndFlush

default io.netty.channel.ChannelFuture writeAndFlush(Object msg)

Specified by:

writeAndFlush in interface io.netty.channel.Channel

Specified by:

writeAndFlush in interface io.netty.channel.ChannelOutboundInvoker

newPromise

default io.netty.channel.ChannelPromise newPromise()

Specified by:

newPromise in interface io.netty.channel.Channel

Specified by:

newPromise in interface io.netty.channel.ChannelOutboundInvoker

newProgressivePromise

default io.netty.channel.ChannelProgressivePromise newProgressivePromise()

Specified by:

newProgressivePromise in interface io.netty.channel.Channel

Specified by:

newProgressivePromise in interface io.netty.channel.ChannelOutboundInvoker

newSucceededFuture

default io.netty.channel.ChannelFuture newSucceededFuture()

Specified by:

newSucceededFuture in interface io.netty.channel.Channel

Specified by:

newSucceededFuture in interface io.netty.channel.ChannelOutboundInvoker

newFailedFuture

default io.netty.channel.ChannelFuture newFailedFuture(Throwable cause)

Specified by:

newFailedFuture in interface io.netty.channel.Channel

Specified by:

newFailedFuture in interface io.netty.channel.ChannelOutboundInvoker

voidPromise

default io.netty.channel.ChannelPromise voidPromise()

Specified by:

voidPromise in interface io.netty.channel.Channel

Specified by:

voidPromise in interface io.netty.channel.ChannelOutboundInvoker

shutdownInput

default io.netty.channel.ChannelFuture shutdownInput()

Specified by:

shutdownInput in interface io.netty.channel.socket.DuplexChannel

shutdownInput

default io.netty.channel.ChannelFuture shutdownInput(io.netty.channel.ChannelPromise promise)

Specified by:

shutdownInput in interface io.netty.channel.socket.DuplexChannel

shutdownOutput

default io.netty.channel.ChannelFuture shutdownOutput()

Specified by:

shutdownOutput in interface io.netty.channel.socket.DuplexChannel

shutdown

default io.netty.channel.ChannelFuture shutdown()

Specified by:

shutdown in interface io.netty.channel.socket.DuplexChannel

shutdown

default io.netty.channel.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

io.netty.channel.ChannelFuture shutdown(int error,
                                        io.netty.channel.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 io.netty.channel.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

io.netty.channel.ChannelFuture shutdownInput(int error,
                                             io.netty.channel.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 io.netty.channel.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

io.netty.channel.ChannelFuture shutdownOutput(int error,
                                              io.netty.channel.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()

Specified by:

localAddress in interface io.netty.channel.Channel

remoteAddress

QuicStreamAddress remoteAddress()

Specified by:

remoteAddress in interface io.netty.channel.Channel

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 io.netty.channel.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

io.netty.channel.ChannelFuture updatePriority(QuicStreamPriority priority,
                                              io.netty.channel.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()

Specified by:

parent in interface io.netty.channel.Channel

read

QuicStreamChannel read()

Specified by:

read in interface io.netty.channel.Channel

Specified by:

read in interface io.netty.channel.ChannelOutboundInvoker

flush

QuicStreamChannel flush()

Specified by:

flush in interface io.netty.channel.Channel

Specified by:

flush in interface io.netty.channel.ChannelOutboundInvoker

config

QuicStreamChannelConfig config()

Specified by:

config in interface io.netty.channel.Channel