writeBufferWaterMark
ChannelOption.swift:426static var writeBufferWaterMark: Self { get }
static var writeBufferWaterMark: Self { get }
s7NIOCore13ChannelOptionPA2A0B7OptionsV5TypesO020WriteBufferWaterMarkC0VRszrlE05writeghI0AIvpZ
What are these?9OIIL
where Self == ChannelOptions.Types.WriteBufferWaterMarkOption
import NIOCore
The core abstractions that make up SwiftNIO.
protocol ChannelOption : _NIOPreconcurrencySendable, Equatable
A configuration option that can be set on a Channel
to configure different behaviour.
struct WriteBufferWaterMarkOption
WriteBufferWaterMarkOption
allows users to configure when a Channel
should be marked as writable or not. Once the amount of bytes queued in a Channel
s outbound buffer is larger than WriteBufferWaterMark.high
the channel will be marked as non-writable and so Channel.isWritable
will return false
. Once we were able to write some data out of the outbound buffer and the amount of bytes queued falls below WriteBufferWaterMark.low
the Channel
will become writable again. Once this happens Channel.writable
will return true
again. These writability changes are also propagated through the ChannelPipeline
and so can be intercepted via ChannelInboundHandler.channelWritabilityChanged
.