EmbeddedChannel (Netty API Reference (5.0.0.Alpha4))

Class EmbeddedChannel

java.lang.Object
- io.netty5.util.DefaultAttributeMap
- - io.netty5.channel.AbstractChannel<Channel,SocketAddress,SocketAddress>
  - - io.netty5.channel.embedded.EmbeddedChannel

All Implemented Interfaces:

Channel , ChannelOutboundInvoker , IoHandle , AttributeMap , FuturePromiseFactory , Comparable<Channel>
```
public class EmbeddedChannel
extends AbstractChannel<Channel,SocketAddress,SocketAddress>
```
Base class for Channel implementations that are used in an embedded fashion.

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty5.channel.AbstractChannel
  AbstractChannel.DefaultAbstractChannelPipeline

Constructor Summary

Constructors
Constructor	Description
`EmbeddedChannel ()`	Create a new instance with an `EmbeddedChannelId` and an empty pipeline.
`EmbeddedChannel (boolean register, boolean hasDisconnect, ChannelHandler... handlers)`	Create a new instance with the pipeline initialized with the specified handlers.
`EmbeddedChannel (boolean hasDisconnect, ChannelHandler... handlers)`	Create a new instance with the pipeline initialized with the specified handlers.
`EmbeddedChannel (ChannelHandler... handlers)`	Create a new instance with the pipeline initialized with the specified handlers.
`EmbeddedChannel (ChannelId channelId)`	Create a new instance with the specified ID and an empty pipeline.
`EmbeddedChannel (ChannelId channelId, boolean register, boolean hasDisconnect, ChannelHandler... handlers)`	Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
`EmbeddedChannel (ChannelId channelId, boolean hasDisconnect, ChannelHandler... handlers)`	Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
`EmbeddedChannel (ChannelId channelId, ChannelHandler... handlers)`	Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
`EmbeddedChannel (Channel parent, ChannelId channelId, boolean register, boolean hasDisconnect, ChannelHandler... handlers)`	Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.

Method Summary

All Methods
Modifier and Type	Method	Description
`void`	`advanceTimeBy (long duration, TimeUnit unit)`	Advance the clock of the event loop of this channel by the given duration.
`void`	`checkException ()`	Check if there was any `Throwable` received and if so rethrow it.
`Future<Void>`	`close ()`	Request to close the `Channel` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`Future<Void>`	`disconnect ()`	Request to disconnect from the remote peer and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`protected void`	`doBeginRead ()`	Schedule a read operation.
`protected void`	`doBind (SocketAddress localAddress)`	Bind the `Channel` to the `SocketAddress`
`protected void`	`doClose ()`	Close the `Channel`
`protected boolean`	`doConnect (SocketAddress remoteAddress, SocketAddress localAddress)`	Connect to remote peer.
`protected void`	`doDisconnect ()`	Disconnect this `Channel` from its remote peer
`protected boolean`	`doFinishConnect (SocketAddress requestedRemoteAddress)`	Finish a connect request.
`protected void`	`doShutdown (ChannelShutdownDirection direction)`	Shutdown one direction of the `Channel`.
`protected void`	`doWrite (ChannelOutboundBuffer in)`	Flush the content of the given buffer to the remote peer.
`protected void`	`ensureOpen ()`	Ensure the `Channel` is open and if not throw an exception.
`boolean`	`finish ()`	Mark this `Channel` as finished.
`boolean`	`finishAndReleaseAll ()`	Mark this `Channel` as finished and release all pending message in the inbound and outbound buffer.
`EmbeddedChannel`	`flushInbound ()`	Flushes the inbound of this `Channel`.
`EmbeddedChannel`	`flushOutbound ()`	Flushes the outbound of this `Channel`.
`void`	`freezeTime ()`	Freeze the clock of this channel's event loop.
`protected void`	`handleInboundMessage (Object msg)`	Called for each inbound message.
`protected void`	`handleOutboundMessage (Object msg)`	Called for each outbound message.
`boolean`	`hasPendingTasks ()`	Check whether this channel has any pending tasks that would be executed by a call to `runPendingTasks()`.
`Queue<Object>`	`inboundMessages ()`	Returns the `Queue` which holds all the `Object`s that were received by this `Channel`.
`boolean`	`isActive ()`	Return `true` if the `Channel` is active and so connected.
`boolean`	`isOpen ()`	Returns `true` if the `Channel` is open and may get active later
`boolean`	`isShutdown (ChannelShutdownDirection direction)`	Returns `true` if the `ChannelShutdownDirection` of the `Channel` was shutdown before.
`Queue<Object>`	`lastInboundBuffer ()`	Deprecated. use `inboundMessages()`
`Queue<Object>`	`lastOutboundBuffer ()`	Deprecated. use `outboundMessages()`
`protected SocketAddress`	`localAddress0 ()`	Returns the `SocketAddress` which is bound locally.
`protected DefaultChannelPipeline`	`newChannelPipeline ()`	Returns a new `ChannelPipeline` instance.
`Queue<Object>`	`outboundMessages ()`	Returns the `Queue` which holds all the `Object`s that were written by this `Channel`.
`<T> T`	`readInbound ()`	Return received data from this `Channel`
`<T> T`	`readOutbound ()`	Read data from the outbound.
`Future<Void>`	`register ()`	Request to register on the `EventExecutor` for I/O processing.
`boolean`	`releaseInbound ()`	Release all buffered inbound messages and return `true` if any were in the inbound buffer, `false` otherwise.
`boolean`	`releaseOutbound ()`	Release all buffered outbound messages and return `true` if any were in the outbound buffer, `false` otherwise.
`protected SocketAddress`	`remoteAddress0 ()`	Return the `SocketAddress` which the `Channel` is connected to.
`protected void`	`runAfterTransportAction ()`
`void`	`runPendingTasks ()`	Run all tasks (which also includes scheduled tasks) that are pending in the `EventLoop` for this `Channel`
`long`	`runScheduledPendingTasks ()`	Run all pending scheduled tasks in the `EventLoop` for this `Channel` and return the `nanoseconds` when the next scheduled task is ready to run.
`void`	`unfreezeTime ()`	Unfreeze an event loop that was `frozen`.
`boolean`	`writeInbound (Object... msgs)`	Write messages to the inbound of this `Channel`.
`Future<Void>`	`writeOneInbound (Object msg)`	Writes one message to the inbound of this `Channel` and does not flush it.
`Future<Void>`	`writeOneOutbound (Object msg)`	Writes one message to the outbound of this `Channel` and does not flush it.
`boolean`	`writeOutbound (Object... msgs)`	Write messages to the outbound of this `Channel`.

Methods inherited from class io.netty5.channel.AbstractChannel
annotateConnectException, assertEventLoop, autoReadCleared, bufferAllocator, cacheAddresses, closeForciblyTransport, closeFuture, closeIfClosed, closeTransport, compareTo, deregisterTransport, ensureOpen, equals, executor, filterOutboundMessage, finishConnect, fireChannelActiveIfNotActiveBefore, getExtendedOption, getMaxMessagesPerWrite, getOption, getWriteSpinCount, handleWriteError, hashCode, id, isAllowHalfClosure, isAutoRead, isConnectPending, isExtendedOptionSupported, isOptionSupported, isRegistered, localAddress, metadata, newSupportedIdentityOptionsSet, outboundBuffer, parent, pipeline, prepareToClose, readIfIsAutoRead, recvBufAllocHandle, remoteAddress, safeSetFailure, safeSetSuccess, setBufferAllocator, setExtendedOption, setOption, shutdownTransport, toString, validate, validateEventLoopGroup, validateFileRegion, writableBytes, writeFlushed

Methods inherited from class io.netty5.util.DefaultAttributeMap
attr, hasAttr

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty5.util.AttributeMap
attr, hasAttr

Methods inherited from interface io.netty5.channel.Channel
bind, connect, connect, deregister, flush, isWritable, read, sendOutboundEvent, shutdown, write, writeAndFlush

Methods inherited from interface io.netty5.channel.ChannelOutboundInvoker
newFailedFuture, newPromise, newSucceededFuture, newSucceededFuture

- Constructor Detail
  - EmbeddedChannel
```
public EmbeddedChannel()
```
    Create a new instance with an EmbeddedChannelId and an empty pipeline.
  - EmbeddedChannel
```
public EmbeddedChannel(ChannelId channelId)
```
    Create a new instance with the specified ID and an empty pipeline.
    
    Parameters:
    
    channelId - the ChannelId that will be used to identify this channel
  - EmbeddedChannel
```
public EmbeddedChannel(ChannelHandler... handlers)
```
    Create a new instance with the pipeline initialized with the specified handlers.
    
    Parameters:
    
    handlers - the ChannelHandlers which will be add in the ChannelPipeline
  - EmbeddedChannel
```
public EmbeddedChannel(boolean hasDisconnect,
 ChannelHandler... handlers)
```
    Create a new instance with the pipeline initialized with the specified handlers.
    
    Parameters:
    
    hasDisconnect - false if this Channel will delegate disconnect() to close(), {@link false} otherwise.
    
    handlers - the ChannelHandlers which will be add in the ChannelPipeline
  - EmbeddedChannel
```
public EmbeddedChannel(boolean register,
 boolean hasDisconnect,
 ChannelHandler... handlers)
```
    Create a new instance with the pipeline initialized with the specified handlers.
    
    Parameters:
    
    register - true if this Channel is registered to the EventLoop in the constructor. If false the user will need to call register().
    
    hasDisconnect - false if this Channel will delegate disconnect() to close(), {@link false} otherwise.
    
    handlers - the ChannelHandlers which will be add in the ChannelPipeline
  - EmbeddedChannel
```
public EmbeddedChannel(ChannelId channelId,
 ChannelHandler... handlers)
```
    Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
    
    Parameters:
    
    channelId - the ChannelId that will be used to identify this channel
    
    handlers - the ChannelHandlers which will be add in the ChannelPipeline
  - EmbeddedChannel
```
public EmbeddedChannel(ChannelId channelId,
 boolean hasDisconnect,
 ChannelHandler... handlers)
```
    Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
    
    Parameters:
    
    channelId - the ChannelId that will be used to identify this channel
    
    hasDisconnect - false if this Channel will delegate disconnect() to close(), {@link false} otherwise.
    
    handlers - the ChannelHandlers which will be add in the ChannelPipeline
  - EmbeddedChannel
```
public EmbeddedChannel(ChannelId channelId,
 boolean register,
 boolean hasDisconnect,
 ChannelHandler... handlers)
```
    Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
    
    Parameters:
    
    channelId - the ChannelId that will be used to identify this channel
    
    register - true if this Channel is registered to the EventLoop in the constructor. If false the user will need to call register().
    
    hasDisconnect - false if this Channel will delegate disconnect() to close(), {@link false} otherwise.
    
    handlers - the ChannelHandlers which will be add in the ChannelPipeline
  - EmbeddedChannel
```
public EmbeddedChannel(Channel parent,
 ChannelId channelId,
 boolean register,
 boolean hasDisconnect,
 ChannelHandler... handlers)
```
    Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
    
    Parameters:
    
    parent - the parent Channel of this EmbeddedChannel.
    
    channelId - the ChannelId that will be used to identify this channel
    
    register - true if this Channel is registered to the EventLoop in the constructor. If false the user will need to call register().
    
    hasDisconnect - false if this Channel will delegate disconnect() to close(), {@link false} otherwise.
    
    handlers - the ChannelHandlers which will be add in the ChannelPipeline
- Method Detail
  - register
```
public Future<Void> register()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to register on the EventExecutor for I/O processing. Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.register(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
  - newChannelPipeline
```
protected final DefaultChannelPipeline newChannelPipeline()
```
    Description copied from class: AbstractChannel
    
    Returns a new ChannelPipeline instance.
    
    Overrides:
    
    newChannelPipeline in class AbstractChannel<Channel,SocketAddress,SocketAddress>
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: Channel
    
    Returns true if the Channel is open and may get active later
  - isActive
```
public boolean isActive()
```
    Description copied from interface: Channel
    
    Return true if the Channel is active and so connected.
  - inboundMessages
```
public Queue<Object> inboundMessages()
```
    Returns the Queue which holds all the Objects that were received by this Channel.
  - lastInboundBuffer
```
@Deprecated
public Queue<Object> lastInboundBuffer()
```
    Deprecated.
    use inboundMessages()
  - outboundMessages
```
public Queue<Object> outboundMessages()
```
    Returns the Queue which holds all the Objects that were written by this Channel.
  - lastOutboundBuffer
```
@Deprecated
public Queue<Object> lastOutboundBuffer()
```
    Deprecated.
    use outboundMessages()
  - readInbound
```
public <T> T readInbound()
```
    Return received data from this Channel
  - readOutbound
```
public <T> T readOutbound()
```
    Read data from the outbound. This may return null if nothing is readable.
  - writeInbound
```
public boolean writeInbound(Object... msgs)
```
    Write messages to the inbound of this Channel.
    
    Parameters:
    
    msgs - the messages to be written
    
    Returns:
    
    true if the write operation did add something to the inbound buffer
  - writeOneInbound
```
public Future<Void> writeOneInbound(Object msg)
```
    Writes one message to the inbound of this Channel and does not flush it. This method is conceptually equivalent to Channel.write(Object).
    
    See Also:
    
    writeOneOutbound(Object)
  - flushInbound
```
public EmbeddedChannel flushInbound()
```
    Flushes the inbound of this Channel. This method is conceptually equivalent to Channel.flush().
    
    See Also:
    
    flushOutbound()
  - writeOutbound
```
public boolean writeOutbound(Object... msgs)
```
    Write messages to the outbound of this Channel.
    
    Parameters:
    
    msgs - the messages to be written
    
    Returns:
    
    bufferReadable returns true if the write operation did add something to the outbound buffer
  - writeOneOutbound
```
public Future<Void> writeOneOutbound(Object msg)
```
    Writes one message to the outbound of this Channel and does not flush it. This method is conceptually equivalent to Channel.write(Object).
    
    See Also:
    
    writeOneInbound(Object)
  - flushOutbound
```
public EmbeddedChannel flushOutbound()
```
    Flushes the outbound of this Channel. This method is conceptually equivalent to Channel.flush().
    
    See Also:
    
    flushInbound()
  - finish
```
public boolean finish()
```
    Mark this Channel as finished. Any further try to write data to it will fail.
    
    Returns:
    
    bufferReadable returns true if any of the used buffers has something left to read
  - finishAndReleaseAll
```
public boolean finishAndReleaseAll()
```
    Mark this Channel as finished and release all pending message in the inbound and outbound buffer. Any further try to write data to it will fail.
    
    Returns:
    
    bufferReadable returns true if any of the used buffers has something left to read
  - releaseInbound
```
public boolean releaseInbound()
```
    Release all buffered inbound messages and return true if any were in the inbound buffer, false otherwise.
  - releaseOutbound
```
public boolean releaseOutbound()
```
    Release all buffered outbound messages and return true if any were in the outbound buffer, false otherwise.
  - close
```
public final Future<Void> close()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to close the Channel and notify the Future once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again.
    This will result in having the ChannelHandler.close(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
  - disconnect
```
public final Future<Void> disconnect()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to disconnect from the remote peer and notify the Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.disconnect(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
  - runPendingTasks
```
public void runPendingTasks()
```
    Run all tasks (which also includes scheduled tasks) that are pending in the EventLoop for this Channel
  - runScheduledPendingTasks
```
public long runScheduledPendingTasks()
```
    Run all pending scheduled tasks in the EventLoop for this Channel and return the nanoseconds when the next scheduled task is ready to run. If no other task was scheduled it will return -1.
  - hasPendingTasks
```
public boolean hasPendingTasks()
```
    Check whether this channel has any pending tasks that would be executed by a call to runPendingTasks(). This includes normal tasks, and scheduled tasks where the deadline has expired. If this method returns false, a call to runPendingTasks() would do nothing.
    
    Returns:
    
    true if there are any pending tasks, false otherwise.
  - advanceTimeBy
```
public void advanceTimeBy(long duration,
 TimeUnit unit)
```
    Advance the clock of the event loop of this channel by the given duration. Any scheduled tasks will execute sooner by the given time (but runScheduledPendingTasks() still needs to be called).
  - freezeTime
```
public void freezeTime()
```
    Freeze the clock of this channel's event loop. Any scheduled tasks that are not already due will not run on future runScheduledPendingTasks() calls. While the event loop is frozen, it is still possible to advance time manually so that scheduled tasks execute.
  - unfreezeTime
```
public void unfreezeTime()
```
    Unfreeze an event loop that was frozen. Time will continue at the point where freezeTime() stopped it: if a task was scheduled ten minutes in the future and freezeTime() was called, it will run ten minutes after this method is called again (assuming no advanceTimeBy(long, TimeUnit) calls, and assuming pending scheduled tasks are run at that time using runScheduledPendingTasks()).
  - checkException
```
public void checkException()
```
    Check if there was any Throwable received and if so rethrow it.
  - ensureOpen
```
protected final void ensureOpen()
```
    Ensure the Channel is open and if not throw an exception.
  - localAddress0
```
protected SocketAddress localAddress0()
```
    Description copied from class: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
    
    Specified by:
    
    localAddress0 in class AbstractChannel<Channel,SocketAddress,SocketAddress>
  - remoteAddress0
```
protected SocketAddress remoteAddress0()
```
    Description copied from class: AbstractChannel
    
    Return the SocketAddress which the Channel is connected to.
    
    Specified by:
    
    remoteAddress0 in class AbstractChannel<Channel,SocketAddress,SocketAddress>
  - doBind
```
protected void doBind(SocketAddress localAddress)
 throws Exception 
```
    Description copied from class: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    Specified by:
    
    doBind in class AbstractChannel<Channel,SocketAddress,SocketAddress>
    
    Throws:
    
    Exception
  - doShutdown
```
protected void doShutdown(ChannelShutdownDirection direction)
```
    Description copied from class: AbstractChannel
    
    Shutdown one direction of the Channel.
    
    Specified by:
    
    doShutdown in class AbstractChannel<Channel,SocketAddress,SocketAddress>
    
    Parameters:
    
    direction - the direction to shutdown.
  - isShutdown
```
public boolean isShutdown(ChannelShutdownDirection direction)
```
    Description copied from interface: Channel
    
    Returns true if the ChannelShutdownDirection of the Channel was shutdown before.
  - doDisconnect
```
protected void doDisconnect()
 throws Exception 
```
    Description copied from class: AbstractChannel
    
    Disconnect this Channel from its remote peer
    
    Specified by:
    
    doDisconnect in class AbstractChannel<Channel,SocketAddress,SocketAddress>
    
    Throws:
    
    Exception
  - doClose
```
protected void doClose()
 throws Exception 
```
    Description copied from class: AbstractChannel
    
    Close the Channel
    
    Specified by:
    
    doClose in class AbstractChannel<Channel,SocketAddress,SocketAddress>
    
    Throws:
    
    Exception
  - doBeginRead
```
protected void doBeginRead()
 throws Exception 
```
    Description copied from class: AbstractChannel
    
    Schedule a read operation.
    
    Specified by:
    
    doBeginRead in class AbstractChannel<Channel,SocketAddress,SocketAddress>
    
    Throws:
    
    Exception
  - doWrite
```
protected void doWrite(ChannelOutboundBuffer in)
 throws Exception 
```
    Description copied from class: AbstractChannel
    
    Flush the content of the given buffer to the remote peer.
    
    Specified by:
    
    doWrite in class AbstractChannel<Channel,SocketAddress,SocketAddress>
    
    Throws:
    
    Exception
  - handleOutboundMessage
```
protected void handleOutboundMessage(Object msg)
```
    Called for each outbound message.
    
    See Also:
    
    doWrite(ChannelOutboundBuffer)
  - handleInboundMessage
```
protected void handleInboundMessage(Object msg)
```
    Called for each inbound message.
  - runAfterTransportAction
```
protected void runAfterTransportAction()
```
    Overrides:
    
    runAfterTransportAction in class AbstractChannel<Channel,SocketAddress,SocketAddress>
  - doConnect
```
protected boolean doConnect(SocketAddress remoteAddress,
 SocketAddress localAddress)
```
    Description copied from class: AbstractChannel
    
    Connect to remote peer.
    
    Specified by:
    
    doConnect in class AbstractChannel<Channel,SocketAddress,SocketAddress>
    
    Parameters:
    
    remoteAddress - the address of the remote peer.
    
    localAddress - the local address of this channel.
    
    Returns:
    
    true if the connect was completed, false if AbstractChannel.finishConnect() will be called later again to try finishing the connect.
  - doFinishConnect
```
protected boolean doFinishConnect(SocketAddress requestedRemoteAddress)
```
    Description copied from class: AbstractChannel
    
    Finish a connect request.
    
    Specified by:
    
    doFinishConnect in class AbstractChannel<Channel,SocketAddress,SocketAddress>
    
    Parameters:
    
    requestedRemoteAddress - the remote address of the peer.
    
    Returns:
    
    true if the connect was completed, false if AbstractChannel.finishConnect() will be called later again to try finishing the connect.

Class EmbeddedChannel

Nested Class Summary

Nested classes/interfaces inherited from class io.netty5.channel.AbstractChannel

Constructor Summary

Method Summary

Methods inherited from class io.netty5.channel.AbstractChannel

Methods inherited from class io.netty5.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty5.util.AttributeMap

Methods inherited from interface io.netty5.channel.Channel

Methods inherited from interface io.netty5.channel.ChannelOutboundInvoker

Constructor Detail

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

Method Detail

register

newChannelPipeline

isOpen

isActive

inboundMessages

lastInboundBuffer

outboundMessages

lastOutboundBuffer

readInbound

readOutbound

writeInbound

writeOneInbound

flushInbound

writeOutbound

writeOneOutbound

flushOutbound

finish

finishAndReleaseAll

releaseInbound

releaseOutbound

close

disconnect

runPendingTasks

runScheduledPendingTasks

hasPendingTasks

advanceTimeBy

freezeTime

unfreezeTime

checkException

ensureOpen

localAddress0

remoteAddress0

doBind

doShutdown

isShutdown

doDisconnect

doClose

doBeginRead

doWrite

handleOutboundMessage

handleInboundMessage

runAfterTransportAction

doConnect

doFinishConnect