Protocolswift-nio 2.81.0NIOCore
MulticastChannel
A MulticastChannel is a Channel that supports IP multicast operations: that is, a channel that can join multicast groups.
protocol MulticastChannel : ChannelA MulticastChannel is a Channel that supports IP multicast operations: that is, a channel that can join multicast groups.
protocol MulticastChannel : Channelimport 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.
protocol ChannelOutboundInvokerAllows 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 Sendable@preconcurrency protocol _NIOPreconcurrencySendable : Sendablefunc joinGroup(_ group: SocketAddress, device: NIONetworkDevice?, promise: EventLoopPromise<Void>?) Request that the MulticastChannel join the multicast group given by group on the device given by device.
func joinGroup(_ group: SocketAddress, promise: EventLoopPromise<Void>?) Request that the MulticastChannel join the multicast group given by group.
func leaveGroup(_ group: SocketAddress, device: NIONetworkDevice?, promise: EventLoopPromise<Void>?) Request that the MulticastChannel leave the multicast group given by group on the device given by device.
func leaveGroup(_ group: SocketAddress, promise: EventLoopPromise<Void>?) Request that the MulticastChannel leave the multicast group given by group.
func joinGroup(_ group: SocketAddress, interface: NIONetworkInterface?, promise: EventLoopPromise<Void>?) Request that the MulticastChannel join the multicast group given by group on the interface given by interface.
func leaveGroup(_ group: SocketAddress, interface: NIONetworkInterface?, promise: EventLoopPromise<Void>?) Request that the MulticastChannel leave the multicast group given by group on the interface given by interface.
protocol ChannelHandler : AnyObjectBase protocol for handlers that handle I/O events or intercept an I/O operation.
protocol ChannelOutboundHandler : _ChannelOutboundHandler, _EmittingChannelHandlerChannelHandler which handles outbound I/O events or intercept an outbound I/O operation for a Channel.
protocol ChannelInboundHandler : _ChannelInboundHandler, _EmittingChannelHandlerChannelHandler which handles inbound I/O events for a Channel.
typealias ChannelDuplexHandler = ChannelInboundHandler & ChannelOutboundHandlerA combination of ChannelInboundHandler and ChannelOutboundHandler.
final class ChannelHandlerContextEvery ChannelHandler has – when added to a ChannelPipeline – a corresponding ChannelHandlerContext which is the way ChannelHandlers can interact with other ChannelHandlers in the pipeline.
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.
protocol RemovableChannelHandler : ChannelHandlerA RemovableChannelHandler is a ChannelHandler that can be dynamically removed from a ChannelPipeline whilst the Channel is operating normally. A RemovableChannelHandler is required to remove itself from the ChannelPipeline (using ChannelHandlerContext.leavePipeline) as soon as possible.
struct NIOAnyNIOAny is an opaque container for values of any type, similar to Swift’s builtin Any type. Contrary to Any the overhead of NIOAny depends on the the type of the wrapped value. Certain types that are important for the performance of a SwiftNIO application like ByteBuffer, FileRegion and AddressEnvelope<ByteBuffer> can be expected to be wrapped almost without overhead. All others will have similar performance as if they were passed as an Any as NIOAny just like Any will contain them within an existential container.
enum ChannelEventAn Channel related event that is passed through the ChannelPipeline to notify the user.
enum CloseModeSpecify what kind of close operation is requested.
struct ChannelShouldQuiesceEventA Channel user event that is sent when the Channel has been asked to quiesce.
func joinGroup(_ group: SocketAddress) -> EventLoopFuture<Void> func joinGroup(_ group: SocketAddress, device: NIONetworkDevice?) -> EventLoopFuture<Void> func joinGroup(_ group: SocketAddress, device: NIONetworkDevice?, promise: EventLoopPromise<Void>?) Request that the MulticastChannel join the multicast group given by group on the device given by device.
func joinGroup(_ group: SocketAddress, promise: EventLoopPromise<Void>?) func leaveGroup(_ group: SocketAddress) -> EventLoopFuture<Void> func leaveGroup(_ group: SocketAddress, device: NIONetworkDevice?) -> EventLoopFuture<Void> func leaveGroup(_ group: SocketAddress, device: NIONetworkDevice?, promise: EventLoopPromise<Void>?) Request that the MulticastChannel leave the multicast group given by group on the device given by device.
func leaveGroup(_ group: SocketAddress, promise: EventLoopPromise<Void>?) func joinGroup(_ group: SocketAddress, interface: NIONetworkInterface?) -> EventLoopFuture<Void> func leaveGroup(_ group: SocketAddress, interface: NIONetworkInterface?) -> EventLoopFuture<Void>