EmbeddedChannel Class Reference


                    
                    
                    LeftOverState

LeftOverState represents any left-over inbound, outbound, and pending outbound events that hit the EmbeddedChannel and were not consumed when finish was called on the EmbeddedChannel.

EmbeddedChannel is most useful in testing and usually in unit tests, you want to consume all inbound and outbound data to verify they are what you expect. Therefore, when you finish an EmbeddedChannel it will return if it’s either .clean (no left overs) or that it has .leftOvers.

Declaration

Swift

public enum LeftOverState

Show on GitHub


                    
                    
                    BufferState

BufferState represents the state of either the inbound, or the outbound EmbeddedChannel buffer. These buffers contain data that travelled the ChannelPipeline all the way.

If the last ChannelHandler explicitly (by calling fireChannelRead) or implicitly (by not implementing channelRead) sends inbound data into the end of the EmbeddedChannel, it will be held in the EmbeddedChannel‘s inbound buffer. Similarly for write on the outbound side. The state of the respective buffer will be returned from writeInbound/writeOutbound as a BufferState.

Declaration

Swift

public enum BufferState

Show on GitHub


                    
                    
                    WrongTypeError

WrongTypeError is throws if you use readInbound or readOutbound and request a certain type but the first item in the respective buffer is of a different type.

Declaration

Swift

public struct WrongTypeError : Error, Equatable

Show on GitHub


                    
                    
                    isActive

Returns true if the EmbeddedChannel is ‘active’.

An active EmbeddedChannel can be closed by calling close or finish on the EmbeddedChannel.

Note

An EmbeddedChannel starts inactive and can be activated, for example by calling connect.

Declaration

Swift

public var isActive: Bool { get }

Show on GitHub


                    
                    
                    closeFuture

See

Channel.closeFuture

Declaration

Swift

public var closeFuture: EventLoopFuture<Void> { get }

Show on GitHub


                    
                    
                    _channelCore

See

Channel._channelCore

Declaration

Swift

public var _channelCore: ChannelCore { get }

Show on GitHub


                    
                    
                    pipeline

See

Channel.pipeline

Declaration

Swift

public var pipeline: ChannelPipeline { get }

Show on GitHub


                    
                    
                    isWritable

See

Channel.isWritable

Declaration

Swift

public var isWritable: Bool

Show on GitHub


                    
                    
                    finish(acceptAlreadyClosed:)

Synchronously closes the EmbeddedChannel.

Errors in the EmbeddedChannel can be consumed using throwIfErrorCaught.

Declaration

Swift

public func finish(acceptAlreadyClosed: Bool) throws -> LeftOverState

Parameters


                                acceptAlreadyClosed

Whether finish should throw if the EmbeddedChannel has been previously closed.

Return Value

The LeftOverState of the EmbeddedChannel. If all the inbound and outbound events have been consumed (using readInbound / readOutbound) and there are no pending outbound events (unflushed writes) this will be .clean. If there are any unconsumed inbound, outbound, or pending outbound events, the EmbeddedChannel will returns those as .leftOvers(inbound:outbound:pendingOutbound:).

Show on GitHub


                    
                    
                    finish()

Synchronously closes the EmbeddedChannel.

This method will throw if the Channel hit any unconsumed errors or if the close fails. Errors in the EmbeddedChannel can be consumed using throwIfErrorCaught.

Declaration

Swift

public func finish() throws -> LeftOverState

Return Value

The LeftOverState of the EmbeddedChannel. If all the inbound and outbound events have been consumed (using readInbound / readOutbound) and there are no pending outbound events (unflushed writes) this will be .clean. If there are any unconsumed inbound, outbound, or pending outbound events, the EmbeddedChannel will returns those as .leftOvers(inbound:outbound:pendingOutbound:).

Show on GitHub


                    
                    
                    allocator

See

Channel.allocator

Declaration

Swift

public var allocator: ByteBufferAllocator

Show on GitHub


                    
                    
                    eventLoop

See

Channel.eventLoop

Declaration

Swift

public var eventLoop: EventLoop { get }

Show on GitHub


                    
                    
                    embeddedEventLoop

Returns the EmbeddedEventLoop that this EmbeddedChannel uses. This will return the same instance as EmbeddedChannel.eventLoop but as the concrete EmbeddedEventLoop rather than as EventLoop existential.

Declaration

Swift

public var embeddedEventLoop: EmbeddedEventLoop

Show on GitHub


                    
                    
                    localAddress

See

Channel.localAddress

Declaration

Swift

public var localAddress: SocketAddress?

Show on GitHub


                    
                    
                    remoteAddress

See

Channel.remoteAddress

Declaration

Swift

public var remoteAddress: SocketAddress?

Show on GitHub


                    
                    
                    parent

nil because EmbeddedChannels don’t have parents.

Declaration

Swift

public let parent: Channel?

Show on GitHub


                    
                    
                    readOutbound(as:)

If available, this method reads one element of type T out of the EmbeddedChannel‘s outbound buffer. If the first element was of a different type than requested, EmbeddedChannel.WrongTypeError will be thrown, if there are no elements in the outbound buffer, nil will be returned.

Data hits the EmbeddedChannel’s outbound buffer when data was written using write, then flushed, and then travelled the ChannelPipeline all the way too the front. For data to hit the outbound buffer, the very first ChannelHandler must have written and flushed it either explicitly (by calling ChannelHandlerContext.write and flush) or implicitly by not implementing write/flush.

Note

Outbound events travel the ChannelPipeline back to front.

Note

EmbeddedChannel.writeOutbound will write data through the ChannelPipeline, starting with last ChannelHandler.

Declaration

Swift

@inlinable
public func readOutbound<T>(as type: T.Type = T.self) throws -> T?

Show on GitHub


                    
                    
                    readInbound(as:)

If available, this method reads one element of type T out of the EmbeddedChannel‘s inbound buffer. If the first element was of a different type than requested, EmbeddedChannel.WrongTypeError will be thrown, if there are no elements in the outbound buffer, nil will be returned.

Data hits the EmbeddedChannel’s inbound buffer when data was send through the pipeline using fireChannelRead and then travelled the ChannelPipeline all the way too the back. For data to hit the inbound buffer, the last ChannelHandler must have send the event either explicitly (by calling ChannelHandlerContext.fireChannelRead) or implicitly by not implementing channelRead.

Note

EmbeddedChannel.writeInbound will fire data through the ChannelPipeline using fireChannelRead.

Declaration

Swift

@inlinable
public func readInbound<T>(as type: T.Type = T.self) throws -> T?

Show on GitHub


                    
                    
                    writeInbound(_:)

Undocumented

Declaration

Swift

@discardableResult
@inlinable
public func writeInbound<T>(_ data: T) throws -> BufferState

Show on GitHub


                    
                    
                    writeOutbound(_:)

Undocumented

Declaration

Swift

@discardableResult
@inlinable
public func writeOutbound<T>(_ data: T) throws -> BufferState

Show on GitHub


                    
                    
                    throwIfErrorCaught()

This method will throw the error that is stored in the EmbeddedChannel if any.

The EmbeddedChannel will store an error some error travels the ChannelPipeline all the way past its end.

Declaration

Swift

public func throwIfErrorCaught() throws

Show on GitHub


                    
                    
                    init(handler:loop:)

Create a new instance.

During creation it will automatically also register itself on the EmbeddedEventLoop.

Declaration

Swift

public init(handler: ChannelHandler? = nil, loop: EmbeddedEventLoop = EmbeddedEventLoop())

Parameters

`handler`	The `ChannelHandler` to add to the `ChannelPipeline` before register or `nil` if none should be added.
`loop`	The `EmbeddedEventLoop` to use.

Show on GitHub


                    
                    
                    setOption(_:value:)

See

Channel.setOption

Declaration

Swift

public func setOption<Option>(_ option: Option, value: Option.Value) -> EventLoopFuture<Void> where Option : ChannelOption

Show on GitHub


                    
                    
                    getOption(_:)

See

Channel.getOption

Declaration

Swift

public func getOption<Option>(_ option: Option) -> EventLoopFuture<Option.Value> where Option : ChannelOption

Show on GitHub


                    
                    
                    bind(to:promise:)

Fires the (outbound) bind event through the ChannelPipeline. If the event hits the EmbeddedChannel which happens when it travels the ChannelPipeline all the way to the front, this will also set the EmbeddedChannel‘s localAddress.

Declaration

Swift

public func bind(to address: SocketAddress, promise: EventLoopPromise<Void>?)

Parameters

`address`	The address to fake-bind to.
`promise`	The `EventLoopPromise` which will be fulfilled when the fake-bind operation has been done.

Show on GitHub


                    
                    
                    connect(to:promise:)

Fires the (outbound) connect event through the ChannelPipeline. If the event hits the EmbeddedChannel which happens when it travels the ChannelPipeline all the way to the front, this will also set the EmbeddedChannel‘s remoteAddress.

Declaration

Swift

public func connect(to address: SocketAddress, promise: EventLoopPromise<Void>?)

Parameters

`address`	The address to fake-bind to.
`promise`	The `EventLoopPromise` which will be fulfilled when the fake-bind operation has been done.

Show on GitHub