Required Instance Propertyswift-nio 2.81.0NIOCore
pipeline
The ChannelPipeline which handles all I/O events and requests associated with this Channel.
var pipeline: ChannelPipeline { get }The ChannelPipeline which handles all I/O events and requests associated with this Channel.
var pipeline: ChannelPipeline { get }import NIOCoreThe core abstractions that make up SwiftNIO.
protocol Channel : AnyObject, ChannelOutboundInvoker, _NIOPreconcurrencySendableA Channel is easiest thought of as a network socket. But it can be anything that is capable of I/O operations such as read, write, connect, and bind.
final class ChannelPipelineA list of ChannelHandlers that handle or intercept inbound events and outbound operations of a Channel. ChannelPipeline implements an advanced form of the Intercepting Filter pattern to give a user full control over how an event is handled and how the ChannelHandlers in a pipeline interact with each other.
var _channelCore: ChannelCore { get }Reach out to the _ChannelCore.
var allocator: ByteBufferAllocator { get }The Channel’s ByteBuffer allocator. This is the only supported way of allocating ByteBuffers to be used with this Channel.
var closeFuture: EventLoopFuture<Void> { get }The closeFuture will fire when the Channel has been closed.
var isActive: Bool { get }Returns if this Channel is currently active. Active is defined as the period of time after the channelActive and before channelInactive has fired. The main use for this is to know if channelActive or channelInactive can be expected next when handlerAdded was received.
var isWritable: Bool { get }Returns if this Channel is currently writable.
var localAddress: SocketAddress? { get }The local SocketAddress.
var parent: Channel? { get }Channels are hierarchical and might have a parent Channel. Channel hierarchies are in use for certain protocols such as HTTP/2.
var remoteAddress: SocketAddress? { get }The remote peer’s SocketAddress.
var syncOptions: NIOSynchronousChannelOptions? { get }Returns a view of the Channel exposing synchronous versions of setOption and getOption. The default implementation returns nil, and Channel implementations must opt in to support this behavior.
func getOption<Option>(_ option: Option) -> EventLoopFuture<Option.Value> where Option : ChannelOption Get the value of option for this Channel.
func setOption<Option>(_ option: Option, value: Option.Value) -> EventLoopFuture<Void> where Option : ChannelOption Set option to value on this Channel.
@preconcurrency func write<T>(_ any: T) -> EventLoopFuture<Void> where T : Sendable Write data into the Channel, automatically wrapping with NIOAny.
@preconcurrency func write<T>(_ any: T, promise: EventLoopPromise<Void>?) where T : Sendable Write data into the Channel, automatically wrapping with NIOAny.
@preconcurrency func writeAndFlush<T>(_ any: T) -> EventLoopFuture<Void> where T : Sendable Write and flush data into the Channel, automatically wrapping with NIOAny.
@preconcurrency func writeAndFlush<T>(_ any: T, promise: EventLoopPromise<Void>?) where T : Sendable Write and flush data into the Channel, automatically wrapping with NIOAny.