Protocolswift-nio 2.72.0NIOCore
ChannelCore
The core Channel methods that are for internal use of the Channel implementation only.
protocol ChannelCore : AnyObjectRequirements
Instance members
func bind0(to: SocketAddress, promise: EventLoopPromise<Void>?) Bind to a
SocketAddress.func channelRead0(NIOAny) Called when data was read from the
Channelbut it was not consumed by anyChannelInboundHandlerin theChannelPipeline.func close0(error: Error, mode: CloseMode, promise: EventLoopPromise<Void>?) Close the
Channel.func connect0(to: SocketAddress, promise: EventLoopPromise<Void>?) Connect to a
SocketAddress.func errorCaught0(error: Error) Called when an inbound error was encountered but was not consumed by any
ChannelInboundHandlerin theChannelPipeline.func flush0() Try to flush out all previous written messages that are pending.
func localAddress0() throws -> SocketAddress Returns the local bound
SocketAddress.func read0() Request that the
Channelperform a read when data is ready.func register0(promise: EventLoopPromise<Void>?) Register with the
EventLoopto receive I/O notifications.func registerAlreadyConfigured0(promise: EventLoopPromise<Void>?) Register channel as already connected or bound socket.
func remoteAddress0() throws -> SocketAddress Return the connected
SocketAddress.func triggerUserOutboundEvent0(Any, promise: EventLoopPromise<Void>?) Trigger an outbound event.
func write0(NIOAny, promise: EventLoopPromise<Void>?) Write the given data to the outbound buffer.
See also
protocol ChannelInvokerA protocol that signals that outbound and inbound events are triggered by this invoker.
protocol ChannelInboundInvokerFire inbound events related to a
Channelthrough theChannelPipelineuntil its end is reached or it’s consumed by aChannelHandler.protocol ChannelOutboundInvokerAllows users to invoke an “outbound” operation related to a
Channelthat will flow through theChannelPipelineuntil it will finally be executed by the theChannelCoreimplementation.
Citizens in NIOCore
Instance members
func removeHandlers(pipeline: ChannelPipeline) Removes the
ChannelHandlers from theChannelPipelinepipeline, and closes thatChannelPipeline.func tryUnwrapData<T>(NIOAny, as: T.Type) -> T? Attempts to unwrap the given
NIOAnyas a specific concrete type.func unwrapData<T>(NIOAny, as: T.Type) -> T Unwraps the given
NIOAnyas a specific concrete type.
Show obsolete interfaces (1)
Hide obsolete interfaces
func removeHandlers(channel: Channel) Removes the
ChannelHandlers from theChannelPipelinebelonging tochannel, and closes thatChannelPipeline.