Protocolswift-nio 2.81.0NIOCore
ChannelOption
A configuration option that can be set on a Channel to configure different behaviour.
protocol ChannelOption : _NIOPreconcurrencySendable, EquatableA configuration option that can be set on a Channel to configure different behaviour.
protocol ChannelOption : _NIOPreconcurrencySendable, Equatableimport NIOCoreThe core abstractions that make up SwiftNIO.
@preconcurrency protocol _NIOPreconcurrencySendable : Sendableprotocol EquatableA type that can be compared for value equality.
protocol Sendableassociatedtype Value : SendableThe type of the ChannelOption’s value.
protocol NIOSynchronousChannelOptionsstruct ChannelOptionsProvides ChannelOptions to be used with a Channel, Bootstrap or ServerBootstrap.
protocol SocketOptionProvider : _NIOPreconcurrencySendableThis protocol defines an object, most commonly a Channel, that supports setting and getting socket options (via setsockopt/getsockopt or similar). It provides a strongly typed API that makes working with larger, less-common socket options easier than the ChannelOption API allows.
protocol RecvByteBufferAllocator : _NIOPreconcurrencySendableAllocates ByteBuffers to be used to read bytes from a Channel and records the number of the actual bytes that were used.
struct AdaptiveRecvByteBufferAllocatorRecvByteBufferAllocator which will gracefully increment or decrement the buffer size on the feedback that was recorded.
struct FixedSizeRecvByteBufferAllocatorRecvByteBufferAllocator which will always return a ByteBuffer with the same fixed size no matter what was recorded.
typealias AllocatorOption = ChannelOptions.Types.AllocatorOptiontypealias AllowRemoteHalfClosureOption = ChannelOptions.Types.AllowRemoteHalfClosureOptiontypealias AutoReadOption = ChannelOptions.Types.AutoReadOptiontypealias BacklogOption = ChannelOptions.Types.BacklogOptiontypealias ConnectTimeoutOption = ChannelOptions.Types.ConnectTimeoutOptiontypealias DatagramVectorReadMessageCountOption = ChannelOptions.Types.DatagramVectorReadMessageCountOptiontypealias MaxMessagesPerReadOption = ChannelOptions.Types.MaxMessagesPerReadOptiontypealias RecvAllocatorOption = ChannelOptions.Types.RecvAllocatorOptiontypealias SocketOption = ChannelOptions.Types.SocketOptiontypealias SocketOptionLevel = Inttypealias SocketOptionName = Int32typealias SocketOptionValue = Inttypealias WriteBufferWaterMarkOption = ChannelOptions.Types.WriteBufferWaterMarkOptiontypealias WriteBufferWaterMark = ChannelOptions.Types.WriteBufferWaterMarktypealias WriteSpinOption = ChannelOptions.Types.WriteSpinOptionstruct SocketOptionSocketOption allows users to specify configuration settings that are directly applied to the underlying socket file descriptor.
static func ipOption(_ name: NIOBSDSocket.Option) -> Self static func socket(_ level: SocketOptionLevel, _ name: SocketOptionName) -> Self static func socketOption(_ name: NIOBSDSocket.Option) -> Self static func tcpOption(_ name: NIOBSDSocket.Option) -> Self struct BacklogOptionBacklogOption allows users to configure the backlog value as specified in man 2 listen. This is only useful for ServerSocketChannels.
static var backlog: Self { get }struct AutoReadOptionAutoReadOption allows users to configure if a Channel should automatically call Channel.read again once all data was read from the transport or if the user is responsible to call Channel.read manually.
static var autoRead: Self { get }struct AllocatorOptionAllocatorOption allows to specify the ByteBufferAllocator to use.
static var allocator: Self { get }struct WriteSpinOptionWriteSpinOption allows users to configure the number of repetitions of a only partially successful write call before considering the Channel not writable. Setting this option to 0 means that we only issue one write call and if that call does not write all the bytes, we consider the Channel not writable.
static var writeSpin: Self { get }struct ReceivePacketInfoWhen set to true IP level Packet Info information will be reported through AddressedEnvelope.Metadata for UDP packets.
static var receivePacketInfo: Self { get }struct DatagramSegmentSizeDatagramSegmentSize controls the UDP_SEGMENT socket option (sometimes reffered to as ‘GSO’) which allows for large writes to be sent via sendmsg and sendmmsg and segmented into separate datagrams by the kernel (or in some cases, the NIC). The size of segments the large write is split into is controlled by the value of this option (note that writes do not need to be a multiple of this option).
static var datagramSegmentSize: Self { get }struct RecvAllocatorOptionRecvAllocatorOption allows users to specify the RecvByteBufferAllocator to use.
static var recvAllocator: Self { get }struct ConnectTimeoutOptionConnectTimeoutOption allows users to configure the TimeAmount after which a connect will fail if it was not established in the meantime. May be nil, in which case the connection attempt will never time out.
static var connectTimeout: Self { get }struct DatagramReceiveOffloadDatagramReceiveOffload sets the UDP_GRO socket option which allows for datagrams to be accumulated by the kernel (or in some cases, the NIC) and reduces traversals in the kernel’s networking layer.
static var datagramReceiveOffload: Self { get }struct MaxMessagesPerReadOptionMaxMessagesPerReadOption allows users to configure the maximum number of read calls to the underlying transport are performed before wait again until there is more to read and be notified.
static var maxMessagesPerRead: Self { get }struct WriteBufferWaterMarkOptionWriteBufferWaterMarkOption allows users to configure when a Channel should be marked as writable or not. Once the amount of bytes queued in a Channels 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.
static var writeBufferWaterMark: Self { get }struct BufferedWritableBytesOptionBufferedWritableBytesOption allows users to know the number of writable bytes currently buffered in the Channel.
static var bufferedWritableBytes: Self { get }struct AllowRemoteHalfClosureOptionAllowRemoteHalfClosureOption allows users to configure whether the Channel will close itself when its remote peer shuts down its send stream, or whether it will remain open. If set to false (the default), the Channel will be closed automatically if the remote peer shuts down its send stream. If set to true, the Channel will not be closed: instead, a ChannelEvent.inboundClosed user event will be sent on the ChannelPipeline, and no more data will be received.
static var allowRemoteHalfClosure: Self { get }struct DatagramVectorReadMessageCountOptionDatagramVectorReadMessageCountOption allows users to configure the number of messages to attempt to read in a single syscall on a datagram Channel.
static var datagramVectorReadMessageCount: Self { get }struct ExplicitCongestionNotificationsOptionWhen set to true IP level ECN information will be reported through AddressedEnvelope.Metadata
static var explicitCongestionNotification: Self { get }import NIOPosixstruct LocalVsockContextIDThis get-only option is used on channels backed by vsock sockets to get the local VSOCK context ID.
static var localVsockContextID: Self { get }