AbstractChannel (Netty 3.10.5.Final API文档

java.lang.Object
- org.jboss.netty.channel.AbstractChannel

所有已实现的接口:

java.lang.Comparable<Channel>, Channel

直接已知子类:

AbstractServerChannel, NioDatagramChannel, NioSocketChannel
```
public abstract class AbstractChannel
extends java.lang.Object
implements Channel
```
A skeletal Channel implementation.

字段概要
- 从接口继承的字段 org.jboss.netty.channel.Channel
  OP_NONE, OP_READ, OP_READ_WRITE, OP_WRITE

构造器概要

构造器
限定符	构造器和说明
`protected`	`AbstractChannel(Channel parent, ChannelFactory factory, ChannelPipeline pipeline, ChannelSink sink)` Creates a new instance.
`protected`	`AbstractChannel(java.lang.Integer id, Channel parent, ChannelFactory factory, ChannelPipeline pipeline, ChannelSink sink)` (Internal use only) Creates a new temporary instance with the specified ID.

方法概要

方法
限定符和类型	方法和说明
`ChannelFuture`	`bind(java.net.SocketAddress localAddress)` Binds this channel to the specified local address asynchronously.
`ChannelFuture`	`close()` Closes this channel asynchronously.
`int`	`compareTo(Channel o)` Compares the ID of the two channels.
`ChannelFuture`	`connect(java.net.SocketAddress remoteAddress)` Connects this channel to the specified remote address asynchronously.
`ChannelFuture`	`disconnect()` Disconnects this channel from the current remote address asynchronously.
`boolean`	`equals(java.lang.Object o)` Returns `true` if and only if the specified object is identical with this channel (i.e: `this == o`).
`java.lang.Object`	`getAttachment()` Retrieves an object which is `attached` to this `Channel`.
`ChannelFuture`	`getCloseFuture()` Returns the `ChannelFuture` which will be notified when this channel is closed.
`ChannelFactory`	`getFactory()` Returns the `ChannelFactory` which created this channel.
`java.lang.Integer`	`getId()` Returns the unique integer ID of this channel.
`int`	`getInterestOps()` Returns the current `interestOps` of this channel.
`protected int`	`getInternalInterestOps()`
`Channel`	`getParent()` Returns the parent of this channel.
`ChannelPipeline`	`getPipeline()` Returns the `ChannelPipeline` which handles `ChannelEvent`s associated with this channel.
`protected ChannelFuture`	`getSucceededFuture()` Returns the cached `SucceededChannelFuture` instance.
`protected ChannelFuture`	`getUnsupportedOperationFuture()` Returns the `FailedChannelFuture` whose cause is an `UnsupportedOperationException`.
`boolean`	`getUserDefinedWritability(int index)` Returns `true` if and only if the user-defined writability flag at the specified index is set to `true`.
`int`	`hashCode()` Returns the ID of this channel.
`boolean`	`isOpen()` Returns `true` if and only if this channel is open.
`boolean`	`isReadable()` Returns `true` if and only if the I/O thread will read a message from this channel.
`boolean`	`isWritable()` Returns `true` if and only if the I/O thread will perform the requested write operation immediately.
`void`	`setAttachment(java.lang.Object attachment)` Attaches an object to this `Channel` to store a stateful information
`protected boolean`	`setClosed()` Marks this channel as closed.
`ChannelFuture`	`setInterestOps(int interestOps)` Changes the `interestOps` of this channel asynchronously.
`protected void`	`setInternalInterestOps(int interestOps)` Sets the `interestOps` property of this channel immediately.
`ChannelFuture`	`setReadable(boolean readable)` Suspends or resumes the read operation of the I/O thread asynchronously.
`protected boolean`	`setUnwritable()`
`void`	`setUserDefinedWritability(int index, boolean writable)` Sets a user-defined writability flag at the specified index.
`protected boolean`	`setWritable()`
`java.lang.String`	`toString()` Returns the `String` representation of this channel.
`ChannelFuture`	`unbind()` Unbinds this channel from the current local address asynchronously.
`ChannelFuture`	`write(java.lang.Object message)` Sends a message to this channel asynchronously.
`ChannelFuture`	`write(java.lang.Object message, java.net.SocketAddress remoteAddress)` Sends a message to this channel asynchronously.

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

从接口继承的方法 org.jboss.netty.channel.Channel
getConfig, getLocalAddress, getRemoteAddress, isBound, isConnected

- 构造器详细资料
  - AbstractChannel
```
protected AbstractChannel(Channel parent,
               ChannelFactory factory,
               ChannelPipeline pipeline,
               ChannelSink sink)
```
    Creates a new instance.
    
    参数:
    parent - the parent of this channel. null if there's no parent.
    factory - the factory which created this channel
    pipeline - the pipeline which is going to be attached to this channel
    sink - the sink which will receive downstream events from the pipeline and send upstream events to the pipeline
  - AbstractChannel
```
protected AbstractChannel(java.lang.Integer id,
               Channel parent,
               ChannelFactory factory,
               ChannelPipeline pipeline,
               ChannelSink sink)
```
    (Internal use only) Creates a new temporary instance with the specified ID.
    
    参数:
    parent - the parent of this channel. null if there's no parent.
    factory - the factory which created this channel
    pipeline - the pipeline which is going to be attached to this channel
    sink - the sink which will receive downstream events from the pipeline and send upstream events to the pipeline
- 方法详细资料
  - getId
```
public final java.lang.Integer getId()
```
    从接口复制的说明: Channel
    
    Returns the unique integer ID of this channel.
    
    指定者:
    
    getId 在接口中 Channel
  - getParent
```
public Channel getParent()
```
    从接口复制的说明: Channel
    
    Returns the parent of this channel.
    
    指定者:
    
    getParent 在接口中 Channel
    
    返回:
    the parent channel. null if this channel does not have a parent channel.
  - getFactory
```
public ChannelFactory getFactory()
```
    从接口复制的说明: Channel
    
    Returns the ChannelFactory which created this channel.
    
    指定者:
    
    getFactory 在接口中 Channel
  - getPipeline
```
public ChannelPipeline getPipeline()
```
    从接口复制的说明: Channel
    
    Returns the ChannelPipeline which handles ChannelEvents associated with this channel.
    
    指定者:
    
    getPipeline 在接口中 Channel
  - getSucceededFuture
```
protected ChannelFuture getSucceededFuture()
```
    Returns the cached SucceededChannelFuture instance.
  - getUnsupportedOperationFuture
```
protected ChannelFuture getUnsupportedOperationFuture()
```
    Returns the FailedChannelFuture whose cause is an UnsupportedOperationException.
  - hashCode
```
public final int hashCode()
```
    Returns the ID of this channel.
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - equals
```
public final boolean equals(java.lang.Object o)
```
    Returns true if and only if the specified object is identical with this channel (i.e: this == o).
    
    覆盖:
    
    equals 在类中 java.lang.Object
  - compareTo
```
public final int compareTo(Channel o)
```
    Compares the ID of the two channels.
    
    指定者:
    
    compareTo 在接口中 java.lang.Comparable<Channel>
  - isOpen
```
public boolean isOpen()
```
    从接口复制的说明: Channel
    
    Returns true if and only if this channel is open.
    
    指定者:
    
    isOpen 在接口中 Channel
  - setClosed
```
protected boolean setClosed()
```
    Marks this channel as closed. This method is intended to be called by an internal component - please do not call it unless you know what you are doing.
    
    返回:
    true if and only if this channel was not marked as closed yet
  - bind
```
public ChannelFuture bind(java.net.SocketAddress localAddress)
```
    从接口复制的说明: Channel
    
    Binds this channel to the specified local address asynchronously.
    
    指定者:
    
    bind 在接口中 Channel
    
    参数:
    localAddress - where to bind
    
    返回:
    the ChannelFuture which will be notified when the bind request succeeds or fails
  - unbind
```
public ChannelFuture unbind()
```
    从接口复制的说明: Channel
    
    Unbinds this channel from the current local address asynchronously.
    
    指定者:
    
    unbind 在接口中 Channel
    
    返回:
    the ChannelFuture which will be notified when the unbind request succeeds or fails
  - close
```
public ChannelFuture close()
```
    从接口复制的说明: Channel
    
    Closes this channel asynchronously. If this channel is bound or connected, it will be disconnected and unbound first. Once a channel is closed, it can not be open again. Calling this method on a closed channel has no effect. Please note that this method always returns the same future instance.
    
    指定者:
    
    close 在接口中 Channel
    
    返回:
    the ChannelFuture which will be notified when the close request succeeds or fails
  - getCloseFuture
```
public ChannelFuture getCloseFuture()
```
    从接口复制的说明: Channel
    
    Returns the ChannelFuture which will be notified when this channel is closed. This method always returns the same future instance.
    
    指定者:
    
    getCloseFuture 在接口中 Channel
  - connect
```
public ChannelFuture connect(java.net.SocketAddress remoteAddress)
```
    从接口复制的说明: Channel
    
    Connects this channel to the specified remote address asynchronously.
    
    指定者:
    
    connect 在接口中 Channel
    
    参数:
    remoteAddress - where to connect
    
    返回:
    the ChannelFuture which will be notified when the connection request succeeds or fails
  - disconnect
```
public ChannelFuture disconnect()
```
    从接口复制的说明: Channel
    
    Disconnects this channel from the current remote address asynchronously.
    
    指定者:
    
    disconnect 在接口中 Channel
    
    返回:
    the ChannelFuture which will be notified when the disconnection request succeeds or fails
  - getInterestOps
```
public int getInterestOps()
```
    从接口复制的说明: Channel
    
    Returns the current interestOps of this channel.
    
    指定者:
    
    getInterestOps 在接口中 Channel
    
    返回:
    Channel.OP_NONE, Channel.OP_READ, Channel.OP_WRITE, or Channel.OP_READ_WRITE
  - setInterestOps
```
public ChannelFuture setInterestOps(int interestOps)
```
    从接口复制的说明: Channel
    
    Changes the interestOps of this channel asynchronously.
    
    指定者:
    
    setInterestOps 在接口中 Channel
    
    参数:
    interestOps - the new interestOps
    
    返回:
    the ChannelFuture which will be notified when the interestOps change request succeeds or fails
  - getInternalInterestOps
```
protected int getInternalInterestOps()
```
  - setInternalInterestOps
```
protected void setInternalInterestOps(int interestOps)
```
    Sets the interestOps property of this channel immediately. This method is intended to be called by an internal component - please do not call it unless you know what you are doing.
  - isReadable
```
public boolean isReadable()
```
    从接口复制的说明: Channel
    Returns true if and only if the I/O thread will read a message from this channel. This method is a shortcut to the following code:
```
 return (getInterestOps() & OP_READ) != 0;
 
```
    指定者:
    
    isReadable 在接口中 Channel
  - isWritable
```
public boolean isWritable()
```
    从接口复制的说明: Channel
    Returns true if and only if the I/O thread will perform the requested write operation immediately. Any write requests made when this method returns false are queued until the I/O thread is ready to process the queued write requests. This method is a shortcut to the following code:
```
 return (getInterestOps() & OP_WRITE) == 0;
 
```
    指定者:
    
    isWritable 在接口中 Channel
  - getUserDefinedWritability
```
public final boolean getUserDefinedWritability(int index)
```
    从接口复制的说明: Channel
    
    Returns true if and only if the user-defined writability flag at the specified index is set to true.
    
    指定者:
    
    getUserDefinedWritability 在接口中 Channel
  - setUserDefinedWritability
```
public final void setUserDefinedWritability(int index,
                             boolean writable)
```
    从接口复制的说明: Channel
    
    Sets a user-defined writability flag at the specified index.
    
    指定者:
    
    setUserDefinedWritability 在接口中 Channel
  - setWritable
```
protected boolean setWritable()
```
  - setUnwritable
```
protected boolean setUnwritable()
```
  - setReadable
```
public ChannelFuture setReadable(boolean readable)
```
    从接口复制的说明: Channel
    Suspends or resumes the read operation of the I/O thread asynchronously. This method is a shortcut to the following code:
```
 int interestOps = getInterestOps();
 if (readable) {
     setInterestOps(interestOps | OP_READ);
 } else {
     setInterestOps(interestOps & ~OP_READ);
 }
 
```
    指定者:
    
    setReadable 在接口中 Channel
    
    参数:
    readable - true to resume the read operation and false to suspend the read operation
    
    返回:
    the ChannelFuture which will be notified when the interestOps change request succeeds or fails
  - write
```
public ChannelFuture write(java.lang.Object message)
```
    从接口复制的说明: Channel
    
    Sends a message to this channel asynchronously. If this channel was created by a connectionless transport (e.g. DatagramChannel) and is not connected yet, you have to call Channel.write(Object, SocketAddress) instead. Otherwise, the write request will fail with NotYetConnectedException and an 'exceptionCaught' event will be triggered.
    
    指定者:
    
    write 在接口中 Channel
    
    参数:
    message - the message to write
    
    返回:
    the ChannelFuture which will be notified when the write request succeeds or fails
  - write
```
public ChannelFuture write(java.lang.Object message,
                  java.net.SocketAddress remoteAddress)
```
    从接口复制的说明: Channel
    
    Sends a message to this channel asynchronously. It has an additional parameter that allows a user to specify where to send the specified message instead of this channel's current remote address. If this channel was created by a connectionless transport (e.g. DatagramChannel) and is not connected yet, you must specify non-null address. Otherwise, the write request will fail with NotYetConnectedException and an 'exceptionCaught' event will be triggered.
    
    指定者:
    
    write 在接口中 Channel
    
    参数:
    message - the message to write
    remoteAddress - where to send the specified message. This method is identical to Channel.write(Object) if null is specified here.
    
    返回:
    the ChannelFuture which will be notified when the write request succeeds or fails
  - getAttachment
```
public java.lang.Object getAttachment()
```
    从接口复制的说明: Channel
    
    Retrieves an object which is attached to this Channel.
    
    指定者:
    
    getAttachment 在接口中 Channel
    
    返回:
    null if no object was attached or null was attached
  - setAttachment
```
public void setAttachment(java.lang.Object attachment)
```
    从接口复制的说明: Channel
    
    Attaches an object to this Channel to store a stateful information
    
    指定者:
    
    setAttachment 在接口中 Channel
  - toString
```
public java.lang.String toString()
```
    Returns the String representation of this channel. The returned string contains the ID, local address, and remote address of this channel for easier identification.
    
    覆盖:
    
    toString 在类中 java.lang.Object

类 AbstractChannel

字段概要

从接口继承的字段 org.jboss.netty.channel.Channel

构造器概要

方法概要

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

从接口继承的方法 org.jboss.netty.channel.Channel

构造器详细资料

AbstractChannel

AbstractChannel

方法详细资料

getId

getParent

getFactory

getPipeline

getSucceededFuture

getUnsupportedOperationFuture

hashCode

equals

compareTo

isOpen

setClosed

bind

unbind

close

getCloseFuture

connect

disconnect

getInterestOps

setInterestOps

getInternalInterestOps

setInternalInterestOps

isReadable

isWritable

getUserDefinedWritability

setUserDefinedWritability

setWritable

setUnwritable

setReadable

write

write

getAttachment

setAttachment

toString