Instance Methodswift-nio 2.72.0NIOEmbedded
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.
func readOutbound<T>(as type: T.Type = T.self) throws -> T? 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.
Other members in extension
Types
enum BufferStateBufferStaterepresents the state of either the inbound, or the outboundEmbeddedChannelbuffer. These buffers contain data that travelled theChannelPipelineall the way.enum LeftOverStateLeftOverStaterepresents any left-over inbound, outbound, and pending outbound events that hit theEmbeddedChanneland were not consumed whenfinishwas called on theEmbeddedChannel.struct SynchronousOptionsstruct WrongTypeErrorWrongTypeErroris throws if you usereadInboundorreadOutboundand request a certain type but the first item in the respective buffer is of a different type.
Type members
init(handler: ChannelHandler?, loop: EmbeddedEventLoop) Create a new instance.
init(handlers: [ChannelHandler], loop: EmbeddedEventLoop) Create a new instance.
Instance members
var allocator: ByteBufferAllocatorvar allowRemoteHalfClosure: Boolvar closeFuture: EventLoopFuture<Void>var embeddedEventLoop: EmbeddedEventLoopReturns the
EmbeddedEventLoopthat thisEmbeddedChanneluses. This will return the same instance asEmbeddedChannel.eventLoopbut as the concreteEmbeddedEventLooprather than asEventLoopexistential.var eventLoop: EventLoopvar isActive: BoolReturns
trueif theEmbeddedChannelis ‘active’.var isWritable: Boolvar localAddress: SocketAddress?let parent: Channel?nilbecauseEmbeddedChannels don’t have parents.var pipeline: ChannelPipelinevar remoteAddress: SocketAddress?var syncOptions: NIOSynchronousChannelOptions?func bind(to: SocketAddress, promise: EventLoopPromise<Void>?) Fires the (outbound)
bindevent through theChannelPipeline. If the event hits theEmbeddedChannelwhich happens when it travels theChannelPipelineall the way to the front, this will also set theEmbeddedChannel’slocalAddress.func connect(to: SocketAddress, promise: EventLoopPromise<Void>?) Fires the (outbound)
connectevent through theChannelPipeline. If the event hits theEmbeddedChannelwhich happens when it travels theChannelPipelineall the way to the front, this will also set theEmbeddedChannel’sremoteAddress.func finish() throws -> LeftOverState Synchronously closes the
EmbeddedChannel.func finish(acceptAlreadyClosed: Bool) throws -> LeftOverState Synchronously closes the
EmbeddedChannel.func getOption<Option>(Option) -> EventLoopFuture<Option.Value> func readInbound<T>(as: T.Type) throws -> T? If available, this method reads one element of type
Tout of theEmbeddedChannel’s inbound buffer. If the first element was of a different type than requested,EmbeddedChannel.WrongTypeErrorwill be thrown, if there are no elements in the outbound buffer,nilwill be returned.func setOption<Option>(Option, value: Option.Value) -> EventLoopFuture<Void> func throwIfErrorCaught() throws This method will throw the error that is stored in the
EmbeddedChannelif any.func writeInbound<T>(T) throws -> BufferState Sends an inbound
channelReadevent followed by achannelReadCompleteevent through theChannelPipeline.func writeOutbound<T>(T) throws -> BufferState Sends an outbound
writeAndFlushevent through theChannelPipeline.