EmbeddedChannel (Netty API Reference (4.1.11.Final))

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.embedded.EmbeddedChannel

All Implemented Interfaces:

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

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- Nested classes/interfaces inherited from interface io.netty.channel.Channel
  Channel.Unsafe

Constructor Summary

Constructors
Constructor and Description
`EmbeddedChannel()` Create a new instance with an `EmbeddedChannelId` and an empty pipeline.
`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 hasDisconnect, ChannelConfig config, 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.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`checkException()` Check if there was any `Throwable` received and if so rethrow it.
`ChannelFuture`	`close()` Request to close the `Channel` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`close(ChannelPromise promise)` Request to close the `Channel` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelConfig`	`config()` Returns the configuration of this channel.
`ChannelFuture`	`disconnect()` Request to disconnect from the remote peer and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`disconnect(ChannelPromise promise)` Request to disconnect from the remote peer and notify the `ChannelFuture` 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 void`	`doDisconnect()` Disconnect this `Channel` from its remote peer
`protected void`	`doRegister()` Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
`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`.
`protected void`	`handleInboundMessage(Object msg)` Called for each inbound message.
`protected void`	`handleOutboundMessage(Object msg)` Called for each outbound message.
`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.
`protected boolean`	`isCompatible(EventLoop loop)` Return `true` if the given `EventLoop` is compatible with this instance.
`boolean`	`isOpen()` Returns `true` if the `Channel` is open and may get active later
`Queue<Object>`	`lastInboundBuffer()` Deprecated. use `inboundMessages()`
`Queue<Object>`	`lastOutboundBuffer()` Deprecated. use `outboundMessages()`
`protected SocketAddress`	`localAddress0()` Returns the `SocketAddress` which is bound locally.
`ChannelMetadata`	`metadata()` Return the `ChannelMetadata` of the `Channel` which describe the nature of the `Channel`.
`protected DefaultChannelPipeline`	`newChannelPipeline()` Returns a new `DefaultChannelPipeline` instance.
`protected AbstractChannel.AbstractUnsafe`	`newUnsafe()` Create a new `AbstractChannel.AbstractUnsafe` instance which will be used for the life-time of the `Channel`
`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.
`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.
`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.
`boolean`	`writeInbound(Object... msgs)` Write messages to the inbound of this `Channel`.
`ChannelFuture`	`writeOneInbound(Object msg)` Writes one message to the inbound of this `Channel` and does not flush it.
`ChannelFuture`	`writeOneInbound(Object msg, ChannelPromise promise)` Writes one message to the inbound of this `Channel` and does not flush it.
`ChannelFuture`	`writeOneOutbound(Object msg)` Writes one message to the outbound of this `Channel` and does not flush it.
`ChannelFuture`	`writeOneOutbound(Object msg, ChannelPromise promise)` 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.netty.channel.AbstractChannel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, doDeregister, equals, eventLoop, filterOutboundMessage, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

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

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

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

- 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(), 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(), false otherwise.
    
    handlers - the ChannelHandlers which will be add in the ChannelPipeline
  - EmbeddedChannel
```
public EmbeddedChannel(ChannelId channelId,
                       boolean hasDisconnect,
                       ChannelConfig config,
                       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(), false otherwise.
    
    config - the ChannelConfig which will be returned by config().
    
    handlers - the ChannelHandlers which will be add in the ChannelPipeline
- Method Detail
  - newChannelPipeline
```
protected final DefaultChannelPipeline newChannelPipeline()
```
    Description copied from class: AbstractChannel
    
    Returns a new DefaultChannelPipeline instance.
    
    Overrides:
    
    newChannelPipeline in class AbstractChannel
  - metadata
```
public ChannelMetadata metadata()
```
    Description copied from interface: Channel
    
    Return the ChannelMetadata of the Channel which describe the nature of the Channel.
  - config
```
public ChannelConfig config()
```
    Description copied from interface: Channel
    
    Returns the configuration of this channel.
  - 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 ChannelFuture writeOneInbound(Object msg)
```
    Writes one message to the inbound of this Channel and does not flush it. This method is conceptually equivalent to AbstractChannel.write(Object).
    
    See Also:
    
    writeOneOutbound(Object)
  - writeOneInbound
```
public ChannelFuture writeOneInbound(Object msg,
                                     ChannelPromise promise)
```
    Writes one message to the inbound of this Channel and does not flush it. This method is conceptually equivalent to AbstractChannel.write(Object, ChannelPromise).
    
    See Also:
    
    writeOneOutbound(Object, ChannelPromise)
  - flushInbound
```
public EmbeddedChannel flushInbound()
```
    Flushes the inbound of this Channel. This method is conceptually equivalent to AbstractChannel.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 ChannelFuture writeOneOutbound(Object msg)
```
    Writes one message to the outbound of this Channel and does not flush it. This method is conceptually equivalent to AbstractChannel.write(Object).
    
    See Also:
    
    writeOneInbound(Object)
  - writeOneOutbound
```
public ChannelFuture writeOneOutbound(Object msg,
                                      ChannelPromise promise)
```
    Writes one message to the outbound of this Channel and does not flush it. This method is conceptually equivalent to AbstractChannel.write(Object, ChannelPromise).
    
    See Also:
    
    writeOneInbound(Object, ChannelPromise)
  - flushOutbound
```
public EmbeddedChannel flushOutbound()
```
    Flushes the outbound of this Channel. This method is conceptually equivalent to AbstractChannel.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 ChannelFuture close()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to close the Channel and notify the ChannelFuture 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 ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    close in interface ChannelOutboundInvoker
    
    Overrides:
    
    close in class AbstractChannel
  - disconnect
```
public final ChannelFuture disconnect()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    disconnect in interface ChannelOutboundInvoker
    
    Overrides:
    
    disconnect in class AbstractChannel
  - close
```
public final ChannelFuture close(ChannelPromise promise)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to close the Channel and notify the ChannelFuture 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. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    close in interface ChannelOutboundInvoker
    
    Overrides:
    
    close in class AbstractChannel
  - disconnect
```
public final ChannelFuture disconnect(ChannelPromise promise)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    disconnect in interface ChannelOutboundInvoker
    
    Overrides:
    
    disconnect in class AbstractChannel
  - 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.
  - 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.
  - isCompatible
```
protected boolean isCompatible(EventLoop loop)
```
    Description copied from class: AbstractChannel
    
    Return true if the given EventLoop is compatible with this instance.
    
    Specified by:
    
    isCompatible in class AbstractChannel
  - localAddress0
```
protected SocketAddress localAddress0()
```
    Description copied from class: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
    
    Specified by:
    
    localAddress0 in class AbstractChannel
  - remoteAddress0
```
protected SocketAddress remoteAddress0()
```
    Description copied from class: AbstractChannel
    
    Return the SocketAddress which the Channel is connected to.
    
    Specified by:
    
    remoteAddress0 in class AbstractChannel
  - doRegister
```
protected void doRegister()
                   throws Exception
```
    Description copied from class: AbstractChannel
    
    Is called after the Channel is registered with its EventLoop as part of the register process. Sub-classes may override this method
    
    Overrides:
    
    doRegister in class AbstractChannel
    
    Throws:
    
    Exception
  - 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
    
    Throws:
    
    Exception
  - doDisconnect
```
protected void doDisconnect()
                     throws Exception
```
    Description copied from class: AbstractChannel
    
    Disconnect this Channel from its remote peer
    
    Specified by:
    
    doDisconnect in class AbstractChannel
    
    Throws:
    
    Exception
  - doClose
```
protected void doClose()
                throws Exception
```
    Description copied from class: AbstractChannel
    
    Close the Channel
    
    Specified by:
    
    doClose in class AbstractChannel
    
    Throws:
    
    Exception
  - doBeginRead
```
protected void doBeginRead()
                    throws Exception
```
    Description copied from class: AbstractChannel
    
    Schedule a read operation.
    
    Specified by:
    
    doBeginRead in class AbstractChannel
    
    Throws:
    
    Exception
  - newUnsafe
```
protected AbstractChannel.AbstractUnsafe newUnsafe()
```
    Description copied from class: AbstractChannel
    
    Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
    
    Specified by:
    
    newUnsafe in class AbstractChannel
  - 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
    
    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.

Class EmbeddedChannel

Nested Class Summary

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

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Constructor Summary

Method Summary

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.util.AttributeMap

Constructor Detail

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

Method Detail

newChannelPipeline

metadata

config

isOpen

isActive

inboundMessages

lastInboundBuffer

outboundMessages

lastOutboundBuffer

readInbound

readOutbound

writeInbound

writeOneInbound

writeOneInbound

flushInbound

writeOutbound

writeOneOutbound

writeOneOutbound

flushOutbound

finish

finishAndReleaseAll

releaseInbound

releaseOutbound

close

disconnect

close

disconnect

runPendingTasks

runScheduledPendingTasks

checkException

ensureOpen

isCompatible

localAddress0

remoteAddress0

doRegister

doBind

doDisconnect

doClose

doBeginRead

newUnsafe

doWrite

handleOutboundMessage

handleInboundMessage