EmbeddedChannel

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.

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.

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.

Returns true if the EmbeddedChannel is ‘active’.

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

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.

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.

nil because EmbeddedChannels don’t have parents.

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.

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.

Undocumented

Undocumented

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.

Create a new instance.

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

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.

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.