ChannelCore

public protocol ChannelCore : AnyObject

The core Channel methods that are for internal use of the Channel implementation only.

Warning

If you are not implementing a custom Channel type, you should never call any of these.

Note

All methods must be called from the EventLoop thread.

localAddress0()
Returns the local bound SocketAddress.
Declaration
Swift

func localAddress0() throws -> SocketAddress
Show on GitHub
remoteAddress0()
Return the connected SocketAddress.
Declaration
Swift

func remoteAddress0() throws -> SocketAddress
Show on GitHub


                    
                    
                    register0(promise:)

Declaration

Swift

func register0(promise: EventLoopPromise<Void>?)

Parameters


                                promise

The EventLoopPromise which should be notified once the operation completes, or nil if no notification should take place.

Show on GitHub


                    
                    
                    registerAlreadyConfigured0(promise:)

Declaration

Swift

func registerAlreadyConfigured0(promise: EventLoopPromise<Void>?)

Parameters


                                promise

The EventLoopPromise which should be notified once the operation completes, or nil if no notification should take place.

Show on GitHub


                    
                    
                    bind0(to:promise:)

Bind to a SocketAddress.

Declaration

Swift

func bind0(to: SocketAddress, promise: EventLoopPromise<Void>?)

Parameters

`to`	The `SocketAddress` to which we should bind the `Channel`.
`promise`	The `EventLoopPromise` which should be notified once the operation completes, or nil if no notification should take place.

Show on GitHub


                    
                    
                    connect0(to:promise:)

Connect to a SocketAddress.

Declaration

Swift

func connect0(to: SocketAddress, promise: EventLoopPromise<Void>?)

Parameters

`to`	The `SocketAddress` to which we should connect the `Channel`.
`promise`	The `EventLoopPromise` which should be notified once the operation completes, or nil if no notification should take place.

Show on GitHub


                    
                    
                    write0(_:promise:)

Write the given data to the outbound buffer.

Declaration

Swift

func write0(_ data: NIOAny, promise: EventLoopPromise<Void>?)

Parameters

`data`	The data to write, wrapped in a `NIOAny`.
`promise`	The `EventLoopPromise` which should be notified once the operation completes, or nil if no notification should take place.

Show on GitHub

flush0()
Try to flush out all previous written messages that are pending.
Declaration
Swift

func flush0()
Show on GitHub
read0()
Request that the Channel perform a read when data is ready.
Declaration
Swift

func read0()
Show on GitHub


                    
                    
                    close0(error:mode:promise:)

Close the Channel.

Declaration

Swift

func close0(error: Error, mode: CloseMode, promise: EventLoopPromise<Void>?)

Parameters

`error`	The `Error` which will be used to fail any pending writes.
`mode`	The `CloseMode` to apply.
`promise`	The `EventLoopPromise` which should be notified once the operation completes, or nil if no notification should take place.

Show on GitHub


                    
                    
                    triggerUserOutboundEvent0(_:promise:)

Trigger an outbound event.

Declaration

Swift

func triggerUserOutboundEvent0(_ event: Any, promise: EventLoopPromise<Void>?)

Parameters

`event`	The triggered event.
`promise`	The `EventLoopPromise` which should be notified once the operation completes, or nil if no notification should take place.

Show on GitHub


                    
                    
                    channelRead0(_:)

Called when data was read from the Channel but it was not consumed by any ChannelInboundHandler in the ChannelPipeline.

Declaration

Swift

func channelRead0(_ data: NIOAny)

Parameters


                                data

The data that was read, wrapped in a NIOAny.

Show on GitHub


                    
                    
                    errorCaught0(error:)

Called when an inbound error was encountered but was not consumed by any ChannelInboundHandler in the ChannelPipeline.

Declaration

Swift

func errorCaught0(error: Error)

Parameters


                                error

The Error that was encountered.

Show on GitHub


                    
                    
                    unwrapData(_:as:)

Extension method

Unwraps the given NIOAny as a specific concrete type.

This method is intended for use when writing custom ChannelCore implementations. This can safely be called in methods like write0 to extract data from the NIOAny provided in those cases.

Note that if the unwrap fails, this will cause a runtime trap. ChannelCore implementations should be concrete about what types they support writing. If multiple types are supported, considere using a tagged union to store the type information like NIO’s own IOData, which will minimise the amount of runtime type checking.

Declaration

Swift

@inlinable
public func unwrapData<T>(_ data: NIOAny, as: T.Type = T.self) -> T

Parameters

`data`	The `NIOAny` to unwrap.
`as`	The type to extract from the `NIOAny`.

Return Value

The content of the NIOAny.

Show on GitHub


                    
                    
                    removeHandlers(channel:)

Extension method

Removes the ChannelHandlers from the ChannelPipeline belonging to channel, and closes that ChannelPipeline.

This method is intended for use when writing custom ChannelCore implementations. This can be called from close0 to tear down the ChannelPipeline when closure is complete.

Declaration

Swift

public func removeHandlers(channel: Channel)

Parameters


                                channel

The Channel whose ChannelPipeline will be closed.

Show on GitHub