Class EmbeddedChannel

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

Modifier and Type

Class

Description

static final class

EmbeddedChannel.Builder

Nested classes/interfaces inherited from class AbstractChannel
AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface Channel
Channel.Unsafe
Constructor Summary

Constructors

Modifier

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, 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.

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.

protected

EmbeddedChannel (EmbeddedChannel.Builder builder)

Create a new instance with the configuration from the given builder.
Method Summary

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.

ChannelFuture

bind (SocketAddress localAddress)

Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

ChannelFuture

bind (SocketAddress localAddress, ChannelPromise promise)

Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

static EmbeddedChannel.Builder

builder()

void

checkException()

Check if there was any Throwable received and if so rethrow it.

final 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.

final 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

connect (SocketAddress remoteAddress)

Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

ChannelFuture

connect (SocketAddress remoteAddress, ChannelPromise promise)

Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

ChannelFuture

connect (SocketAddress remoteAddress, SocketAddress localAddress)

Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

ChannelFuture

connect (SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)

Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

ChannelFuture

deregister()

Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

ChannelFuture

deregister (ChannelPromise promise)

Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

final 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.

final 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 final 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.

Channel

flush()

Request to flush all pending messages via this ChannelOutboundInvoker.

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 Objects 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 final 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 Objects that were written by this Channel.

Channel

read()

Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading.

<T> T

readInbound()

Return received data from this Channel

<T> T

readOutbound()

Read data from the outbound.

void

register()

Register this Channel on its EventLoop.

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.

void

unfreezeTime()

Unfreeze an event loop that was frozen.

Channel.Unsafe

unsafe()

Returns an internal-use-only object that provides unsafe operations.

ChannelFuture

write (Object msg)

Request to write a message via this ChannelHandlerContext through the ChannelPipeline.

ChannelFuture

write (Object msg, ChannelPromise promise)

Request to write a message via this ChannelHandlerContext through the ChannelPipeline.

ChannelFuture

writeAndFlush (Object msg)

Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().

ChannelFuture

writeAndFlush (Object msg, ChannelPromise promise)

Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

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 AbstractChannel
closeFuture, compareTo, doDeregister, doRegister, doShutdownOutput, equals, eventLoop, filterOutboundMessage, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, localAddress, maxMessagesPerWrite, newId, parent, pipeline, remoteAddress, toString, validateFileRegion, voidPromise

Methods inherited from class DefaultAttributeMap
attr, hasAttr

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

Methods inherited from interface AttributeMap
attr, hasAttr

Methods inherited from interface Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, getOption, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, setOption

Constructor Details
- 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(), true otherwise.
  
  handlers - the ChannelHandlers which will be added to 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(), true otherwise.
  
  handlers - the ChannelHandlers which will be added to 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 added to 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(), true otherwise.
  
  handlers - the ChannelHandlers which will be added to 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(), true otherwise.
  
  handlers - the ChannelHandlers which will be added to 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(), true otherwise.
  
  handlers - the ChannelHandlers which will be added to 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(), true otherwise.
  
  config - the ChannelConfig which will be returned by config().
  
  handlers - the ChannelHandlers which will be added to the ChannelPipeline
- EmbeddedChannel
  
  protected EmbeddedChannel(EmbeddedChannel.Builder builder)
  
  Create a new instance with the configuration from the given builder. This method is protected for use by subclasses; Otherwise, please use EmbeddedChannel.Builder.build().
  
  Parameters:
  
  builder - The builder
Method Details
- register
  
  public void register() throws Exception
  
  Register this Channel on its EventLoop.
  
  Throws:
  
  Exception
- 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 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 write(Object, ChannelPromise).
  
  See Also:
  
  writeOneOutbound(Object, ChannelPromise)
- flushInbound
  public EmbeddedChannel flushInbound()
  
  Flushes the inbound of this Channel. This method is conceptually equivalent to 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 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 write(Object, ChannelPromise).
  
  See Also:
  
  writeOneInbound(Object, ChannelPromise)
- flushOutbound
  public EmbeddedChannel flushOutbound()
  
  Flushes the outbound of this Channel. This method is conceptually equivalent to 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.
- 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.
- 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.
- 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.
- bind
  
  public ChannelFuture bind(SocketAddress localAddress)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to bind to the given SocketAddress 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.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
- connect
  
  public ChannelFuture connect(SocketAddress remoteAddress)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
  If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.
  This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
- connect
  
  public ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to connect to the given SocketAddress while bind to the localAddress 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.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
- deregister
  
  public ChannelFuture deregister()
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to deregister from the previous assigned EventExecutor 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.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
- flush
  
  public Channel flush()
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to flush all pending messages via this ChannelOutboundInvoker.
- bind
  
  public ChannelFuture bind(SocketAddress localAddress, ChannelPromise promise)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to bind to the given SocketAddress 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.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
- connect
  
  public ChannelFuture connect(SocketAddress remoteAddress, ChannelPromise promise)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelFuture will be notified.
  If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.
  This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
- connect
  
  public ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to connect to the given SocketAddress while bind to the localAddress 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 and also returned.
  This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
- deregister
  
  public ChannelFuture deregister(ChannelPromise promise)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to deregister from the previous assigned EventExecutor 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.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
- read
  
  public Channel read()
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading. If there's a pending read operation already, this method does nothing.
  This will result in having the ChannelOutboundHandler.read(ChannelHandlerContext) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
- write
  
  public ChannelFuture write(Object msg)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to write a message via this ChannelHandlerContext through the ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelOutboundInvoker.flush() once you want to request to flush all pending data to the actual transport.
- write
  
  public ChannelFuture write(Object msg, ChannelPromise promise)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Request to write a message via this ChannelHandlerContext through the ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelOutboundInvoker.flush() once you want to request to flush all pending data to the actual transport.
- writeAndFlush
  
  public ChannelFuture writeAndFlush(Object msg)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
- writeAndFlush
  
  public ChannelFuture writeAndFlush(Object msg, ChannelPromise promise)
  
  Description copied from interface: ChannelOutboundInvoker
  
  Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().
- runPendingTasks
  
  public void runPendingTasks()
  
  Run all tasks (which also includes scheduled tasks) that are pending in the EventLoop for this Channel
- 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.
- 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.
- 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.
- 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. Subclasses 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
- unsafe
  
  public Channel.Unsafe unsafe()
  
  Description copied from interface: Channel
  
  Returns an internal-use-only object that provides unsafe operations.
  
  Specified by:
  
  unsafe in interface Channel
  
  Overrides:
  
  unsafe 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.
- builder
  
  public static EmbeddedChannel.Builder builder()

Class EmbeddedChannel

Nested Class Summary

Nested classes/interfaces inherited from class AbstractChannel

Nested classes/interfaces inherited from interface Channel

Constructor Summary

Method Summary

Methods inherited from class AbstractChannel

Methods inherited from class DefaultAttributeMap

Methods inherited from class Object

Methods inherited from interface AttributeMap

Methods inherited from interface Channel

Constructor Details

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

Method Details

register

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

bind

connect

connect

deregister

flush

bind

connect

connect

deregister

read

write

write

writeAndFlush

writeAndFlush

runPendingTasks

hasPendingTasks

runScheduledPendingTasks

advanceTimeBy

freezeTime

unfreezeTime

checkException

ensureOpen

isCompatible

localAddress0

remoteAddress0

doRegister

doBind

doDisconnect