EmbeddedChannel (Netty 4.0.56.Final API文档

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

所有已实现的接口:

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

嵌套类概要
- 从类继承的嵌套类/接口 io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- 从接口继承的嵌套类/接口 io.netty.channel.Channel
  Channel.Unsafe

构造器概要

构造器
构造器和说明
`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

方法概要

方法
限定符和类型	方法和说明
`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 `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
`java.util.Queue<java.lang.Object>`	`lastInboundBuffer()` 已过时。 use `inboundMessages()`
`java.util.Queue<java.lang.Object>`	`lastOutboundBuffer()` 已过时。 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 `Object`s 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`.

从类继承的方法 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

从类继承的方法 io.netty.util.DefaultAttributeMap
attr

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 io.netty.util.AttributeMap
attr

- 构造器详细资料
  - EmbeddedChannel
```
public EmbeddedChannel(ChannelHandler... handlers)
```
    Create a new instance
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    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
- 方法详细资料
  - register
```
public void register()
              throws java.lang.Exception
```
    Register this Channel on its EventLoop.
    
    抛出:
    
    java.lang.Exception
  - newChannelPipeline
```
protected final DefaultChannelPipeline newChannelPipeline()
```
    从类复制的说明: AbstractChannel
    
    Returns a new DefaultChannelPipeline instance.
    
    覆盖:
    
    newChannelPipeline 在类中 AbstractChannel
  - metadata
```
public ChannelMetadata metadata()
```
    从接口复制的说明: Channel
    
    Return the ChannelMetadata of the Channel which describe the nature of the Channel.
  - config
```
public ChannelConfig config()
```
    从接口复制的说明: Channel
    
    Returns the configuration of this channel.
  - isOpen
```
public boolean isOpen()
```
    从接口复制的说明: Channel
    
    Returns true if the Channel is open and may get active later
  - isActive
```
public boolean isActive()
```
    从接口复制的说明: 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()
```
    已过时。 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()
```
    已过时。 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.
    
    参数:
    msgs - the messages to be written
    
    返回:
    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.
    
    参数:
    msgs - the messages to be written
    
    返回:
    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.
    
    返回:
    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.
    
    返回:
    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()
```
    从接口复制的说明: 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.
    
    指定者:
    
    close 在接口中 Channel
    
    覆盖:
    
    close 在类中 AbstractChannel
  - disconnect
```
public final ChannelFuture disconnect()
```
    从接口复制的说明: 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.
    
    指定者:
    
    disconnect 在接口中 Channel
    
    覆盖:
    
    disconnect 在类中 AbstractChannel
  - close
```
public final ChannelFuture close(ChannelPromise promise)
```
    从接口复制的说明: 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.
    
    指定者:
    
    close 在接口中 Channel
    
    覆盖:
    
    close 在类中 AbstractChannel
  - disconnect
```
public final ChannelFuture disconnect(ChannelPromise promise)
```
    从接口复制的说明: 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.
    
    指定者:
    
    disconnect 在接口中 Channel
    
    覆盖:
    
    disconnect 在类中 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)
```
    从类复制的说明: AbstractChannel
    
    Return true if the given EventLoop is compatible with this instance.
    
    指定者:
    
    isCompatible 在类中 AbstractChannel
  - localAddress0
```
protected java.net.SocketAddress localAddress0()
```
    从类复制的说明: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
    
    指定者:
    
    localAddress0 在类中 AbstractChannel
  - remoteAddress0
```
protected java.net.SocketAddress remoteAddress0()
```
    从类复制的说明: AbstractChannel
    
    Return the SocketAddress which the Channel is connected to.
    
    指定者:
    
    remoteAddress0 在类中 AbstractChannel
  - doRegister
```
protected void doRegister()
                   throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Is called after the Channel is registered with its EventLoop as part of the register process. Sub-classes may override this method
    
    覆盖:
    
    doRegister 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doBind
```
protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    指定者:
    
    doBind 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doDisconnect
```
protected void doDisconnect()
                     throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Disconnect this Channel from its remote peer
    
    指定者:
    
    doDisconnect 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Close the Channel
    
    指定者:
    
    doClose 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doBeginRead
```
protected void doBeginRead()
                    throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Schedule a read operation.
    
    指定者:
    
    doBeginRead 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - newUnsafe
```
protected AbstractChannel.AbstractUnsafe newUnsafe()
```
    从类复制的说明: AbstractChannel
    
    Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
    
    指定者:
    
    newUnsafe 在类中 AbstractChannel
  - unsafe
```
public Channel.Unsafe unsafe()
```
    从接口复制的说明: Channel
    
    Returns an internal-use-only object that provides unsafe operations.
    
    指定者:
    
    unsafe 在接口中 Channel
    
    覆盖:
    
    unsafe 在类中 AbstractChannel
  - doWrite
```
protected void doWrite(ChannelOutboundBuffer in)
                throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Flush the content of the given buffer to the remote peer.
    
    指定者:
    
    doWrite 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception

类 EmbeddedChannel

嵌套类概要

从类继承的嵌套类/接口 io.netty.channel.AbstractChannel

从接口继承的嵌套类/接口 io.netty.channel.Channel

构造器概要

方法概要

从类继承的方法 io.netty.channel.AbstractChannel

从类继承的方法 io.netty.util.DefaultAttributeMap

从类继承的方法 java.lang.Object

从接口继承的方法 io.netty.util.AttributeMap

构造器详细资料

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

EmbeddedChannel

方法详细资料

register

newChannelPipeline

metadata

config

isOpen

isActive

inboundMessages

lastInboundBuffer

outboundMessages

lastOutboundBuffer

readInbound

readOutbound

writeInbound

writeOutbound

finish

finishAndReleaseAll

releaseInbound

releaseOutbound

close

disconnect

close

disconnect

runPendingTasks

runScheduledPendingTasks

checkException

ensureOpen

isCompatible

localAddress0

remoteAddress0

doRegister

doBind

doDisconnect

doClose

doBeginRead

newUnsafe

unsafe

doWrite