Interface QuicStreamChannelConfig

All Superinterfaces:

ChannelConfig, DuplexChannelConfig

public interface QuicStreamChannelConfig
extends DuplexChannelConfig

DuplexChannelConfig for QUIC streams.

Method Summary

Modifier and Type	Method	Description
boolean	isReadFrames()	Returns true if the QuicStreamChannel will read QuicStreamFrames and fire these through the ChannelPipeline, false if it uses ByteBuf.
QuicStreamChannelConfig	setAllocator(ByteBufAllocator allocator)	Set the ByteBufAllocator which is used for the channel to allocate buffers.
QuicStreamChannelConfig	setAllowHalfClosure(boolean allowHalfClosure)	Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
QuicStreamChannelConfig	setAutoClose(boolean autoClose)	Sets whether the Channel should be closed automatically and immediately on write failure.
QuicStreamChannelConfig	setAutoRead(boolean autoRead)	Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
QuicStreamChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis)	Sets the connect timeout of the channel in milliseconds.
QuicStreamChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead)
QuicStreamChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator)	Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
QuicStreamChannelConfig	setReadFrames(boolean readFrames)	Set this to true if the QuicStreamChannel should read QuicStreamFrames and fire these through the ChannelPipeline, false if it uses ByteBuf.
QuicStreamChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator)	Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
QuicStreamChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark)	Sets the high water mark of the write buffer.
QuicStreamChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark)	Sets the low water mark of the write buffer.
QuicStreamChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)	Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
QuicStreamChannelConfig	setWriteSpinCount(int writeSpinCount)	Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

Methods inherited from interface ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions

Methods inherited from interface DuplexChannelConfig

isAllowHalfClosure

Method Details

setReadFrames

QuicStreamChannelConfig setReadFrames(boolean readFrames)

Set this to true if the QuicStreamChannel should read QuicStreamFrames and fire these through the ChannelPipeline, false if it uses ByteBuf.

Parameters:

readFrames - true if QuicStreamFrames should be used, false if ByteBuf should be used.

Returns:

this instance itself.

isReadFrames

boolean isReadFrames()

Returns true if the QuicStreamChannel will read QuicStreamFrames and fire these through the ChannelPipeline, false if it uses ByteBuf.

Returns:

true if QuicStreamFrames should be used, false if ByteBuf should be used.

setAllowHalfClosure

QuicStreamChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

Description copied from interface: DuplexChannelConfig

Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If true the connection is not closed when the remote peer shuts down output. Instead, ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object) is invoked with a ChannelInputShutdownEvent object. If false, the connection is closed automatically.

Specified by:

setAllowHalfClosure in interface DuplexChannelConfig

setMaxMessagesPerRead

QuicStreamChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DuplexChannelConfig

setWriteSpinCount

QuicStreamChannelConfig setWriteSpinCount(int writeSpinCount)

Description copied from interface: ChannelConfig

Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value. It is similar to what a spin lock is used for in concurrency programming. It improves memory utilization and write throughput depending on the platform that JVM runs on. The default value is 16.

Specified by:

setWriteSpinCount in interface ChannelConfig

Specified by:

setWriteSpinCount in interface DuplexChannelConfig

setAllocator

QuicStreamChannelConfig setAllocator(ByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the ByteBufAllocator which is used for the channel to allocate buffers.

Specified by:

setAllocator in interface ChannelConfig

Specified by:

setAllocator in interface DuplexChannelConfig

setRecvByteBufAllocator

QuicStreamChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Specified by:

setRecvByteBufAllocator in interface DuplexChannelConfig

setAutoRead

QuicStreamChannelConfig setAutoRead(boolean autoRead)

Description copied from interface: ChannelConfig

Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all. The default value is true.

Specified by:

setAutoRead in interface ChannelConfig

Specified by:

setAutoRead in interface DuplexChannelConfig

setAutoClose

QuicStreamChannelConfig setAutoClose(boolean autoClose)

Description copied from interface: ChannelConfig

Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface DuplexChannelConfig

setMessageSizeEstimator

QuicStreamChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

Set the MessageSizeEstimator which is used for the channel to detect the size of a message.

Specified by:

setMessageSizeEstimator in interface ChannelConfig

Specified by:

setMessageSizeEstimator in interface DuplexChannelConfig

setWriteBufferWaterMark

QuicStreamChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Description copied from interface: ChannelConfig

Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.

Specified by:

setWriteBufferWaterMark in interface ChannelConfig

Specified by:

setWriteBufferWaterMark in interface DuplexChannelConfig

setConnectTimeoutMillis

QuicStreamChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Description copied from interface: ChannelConfig

Sets the connect timeout of the channel in milliseconds. If the Channel does not support connect operation, this property is not used at all, and therefore will be ignored.

Specified by:

setConnectTimeoutMillis in interface ChannelConfig

Parameters:

connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.

setWriteBufferHighWaterMark

QuicStreamChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Description copied from interface: ChannelConfig

Sets the high water mark of the write buffer. If the number of bytes queued in the write buffer exceeds this value, Channel.isWritable() will start to return false.

Specified by:

setWriteBufferHighWaterMark in interface ChannelConfig

setWriteBufferLowWaterMark

QuicStreamChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Description copied from interface: ChannelConfig

Sets the low water mark of the write buffer. Once the number of bytes queued in the write buffer exceeded the high water mark and then dropped down below this value, Channel.isWritable() will start to return true again.

Specified by:

setWriteBufferLowWaterMark in interface ChannelConfig