io.netty.channel.embedded

Class EmbeddedChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.embedded.EmbeddedChannel

All Implemented Interfaces:

Channel, AttributeMap, java.lang.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(boolean register, boolean hasDisconnect, ChannelHandler... handlers) Create a new instance with the pipeline initialized with the specified handlers.
EmbeddedChannel(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(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(ChannelHandler... handlers) Create a new instance

Method Summary

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 this 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 this 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(java.net.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.
java.util.Queue<java.lang.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
java.util.Queue<java.lang.Object>	lastInboundBuffer() Deprecated. use inboundMessages()
java.util.Queue<java.lang.Object>	lastOutboundBuffer() Deprecated. use outboundMessages()
protected java.net.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
java.util.Queue<java.lang.Object>	outboundMessages() Returns the Queue which holds all the Objects that were written by this Channel.
java.lang.Object	readInbound() Return received data from this Channel
java.lang.Object	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 java.net.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.
Channel.Unsafe	unsafe() Returns an internal-use-only object that provides unsafe operations.
boolean	writeInbound(java.lang.Object... msgs) Write messages to the inbound of this Channel.
boolean	writeOutbound(java.lang.Object... msgs) Write messages to the outbound of this Channel.

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, doDeregister, doShutdownOutput, equals, eventLoop, filterOutboundMessage, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, toString, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap

attr

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.util.AttributeMap

attr

Constructor Detail

EmbeddedChannel

public EmbeddedChannel(ChannelHandler... handlers)

Create a new instance

Parameters:

handlers - the @link ChannelHandler}s which will be add in the ChannelPipeline

EmbeddedChannel

public EmbeddedChannel(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:

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(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(), false otherwise.

handlers - the ChannelHandlers which will be add in the ChannelPipeline

EmbeddedChannel

public EmbeddedChannel(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:

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

register

public void register()
              throws java.lang.Exception

Register this Channel on its EventLoop.

Throws:

java.lang.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 java.util.Queue<java.lang.Object> inboundMessages()

Returns the Queue which holds all the Objects that were received by this Channel.

lastInboundBuffer

@Deprecated
public java.util.Queue<java.lang.Object> lastInboundBuffer()

Deprecated. use inboundMessages()

outboundMessages

public java.util.Queue<java.lang.Object> outboundMessages()

Returns the Queue which holds all the Objects that were written by this Channel.

lastOutboundBuffer

@Deprecated
public java.util.Queue<java.lang.Object> lastOutboundBuffer()

Deprecated. use outboundMessages()

readInbound

public java.lang.Object readInbound()

Return received data from this Channel

readOutbound

public java.lang.Object readOutbound()

Read data from the outbound. This may return null if nothing is readable.

writeInbound

public boolean writeInbound(java.lang.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

writeOutbound

public boolean writeOutbound(java.lang.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

finish

public boolean finish()

Mark this Channel as finished. Any futher 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: Channel

Request to close this 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 Channel

Overrides:

close in class AbstractChannel

disconnect

public final ChannelFuture disconnect()

Description copied from interface: Channel

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 Channel

Overrides:

disconnect in class AbstractChannel

close

public final ChannelFuture close(ChannelPromise promise)

Description copied from interface: Channel

Request to close this 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 Channel

Overrides:

close in class AbstractChannel

disconnect

public final ChannelFuture disconnect(ChannelPromise promise)

Description copied from interface: Channel

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 Channel

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 java.net.SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected java.net.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 java.lang.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:

java.lang.Exception

doBind

protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel

Throws:

java.lang.Exception

doDisconnect

protected void doDisconnect()
                     throws java.lang.Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

java.lang.Exception

doClose

protected void doClose()
                throws java.lang.Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

java.lang.Exception

doBeginRead

protected void doBeginRead()
                    throws java.lang.Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel

Throws:

java.lang.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 java.lang.Exception

Description copied from class: AbstractChannel

Flush the content of the given buffer to the remote peer.

Specified by:

doWrite in class AbstractChannel

Throws:

java.lang.Exception