Allows users to invoke an “outbound” operation related to a Channel that will flow through the ChannelPipeline until it will finally be executed by the the ChannelCore implementation.
protocol ChannelOutboundInvokerimport NIOCoreThe core abstractions that make up SwiftNIO.
var eventLoop: EventLoop { get }The EventLoop which is used by this ChannelOutboundInvoker for execution.
func bind(to: SocketAddress, promise: EventLoopPromise<Void>?) Bind to a SocketAddress.
func close(mode: CloseMode, promise: EventLoopPromise<Void>?) Close the Channel and so the connection if one exists.
func connect(to: SocketAddress, promise: EventLoopPromise<Void>?) Connect to a SocketAddress.
func flush() Flush data that was previously written via write to the remote peer.
func read() Signal that we want to read from the Channel once there is data ready.
func register(promise: EventLoopPromise<Void>?) Register on an EventLoop and so have all its IO handled.
@preconcurrency func triggerUserOutboundEvent(_ event: Sendable, promise: EventLoopPromise<Void>?) Trigger a custom user outbound event which will flow through the ChannelPipeline.
func write(_ data: NIOAny, promise: EventLoopPromise<Void>?) Write data to the remote peer.
func writeAndFlush(_ data: NIOAny, promise: EventLoopPromise<Void>?) Shortcut for calling write and flush.
protocol ChannelCore : AnyObjectThe core Channel methods that are for internal use of the Channel implementation only.
protocol ChannelInvoker : ChannelInboundInvoker, ChannelOutboundInvokerA protocol that signals that outbound and inbound events are triggered by this invoker.
protocol ChannelInboundInvokerFire inbound events related to a Channel through the ChannelPipeline until its end is reached or it’s consumed by a ChannelHandler.
func bind(to address: SocketAddress, file: StaticString = #fileID, line: UInt = #line) -> EventLoopFuture<Void> Bind to a SocketAddress.
func bind(to address: SocketAddress, file: StaticString = #fileID, line: UInt = #line) async throws Bind to a SocketAddress.
func close(mode: CloseMode = .all, file: StaticString = #fileID, line: UInt = #line) -> EventLoopFuture<Void> Close the Channel and so the connection if one exists.
func close(mode: CloseMode = .all, file: StaticString = #fileID, line: UInt = #line) async throws Close the Channel and so the connection if one exists.
func connect(to address: SocketAddress, file: StaticString = #fileID, line: UInt = #line) -> EventLoopFuture<Void> Connect to a SocketAddress.
func connect(to address: SocketAddress, file: StaticString = #fileID, line: UInt = #line) async throws Connect to a SocketAddress.
func register(file: StaticString = #fileID, line: UInt = #line) -> EventLoopFuture<Void> Register on an EventLoop and so have all its IO handled.
func register(file: StaticString = #fileID, line: UInt = #line) async throws Register on an EventLoop and so have all its IO handled.
@preconcurrency func triggerUserOutboundEvent(_ event: Sendable, file: StaticString = #fileID, line: UInt = #line) -> EventLoopFuture<Void> Trigger a custom user outbound event which will flow through the ChannelPipeline.
@preconcurrency func triggerUserOutboundEvent(_ event: Sendable, file: StaticString = #fileID, line: UInt = #line) async throws Trigger a custom user outbound event which will flow through the ChannelPipeline.
func write(_ data: NIOAny, file: StaticString = #fileID, line: UInt = #line) -> EventLoopFuture<Void> Write data to the remote peer.
func writeAndFlush(_ data: NIOAny, file: StaticString = #fileID, line: UInt = #line) -> EventLoopFuture<Void> Shortcut for calling write and flush.
func writeAndFlush(_ data: NIOAny, file: StaticString = #fileID, line: UInt = #line) async throws Shortcut for calling write and flush.
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.
protocol MulticastChannel : ChannelA MulticastChannel is a Channel that supports IP multicast operations: that is, a channel that can join multicast groups.