org.jboss.netty.channel
类 AbstractChannel

java.lang.Object
  继承者 org.jboss.netty.channel.AbstractChannel
所有已实现的接口:
java.lang.Comparable<Channel>, Channel
直接已知子类:
AbstractServerChannel

public abstract class AbstractChannel
extends java.lang.Object
implements Channel

Channel的脚架实现.


字段摘要
 
从接口 org.jboss.netty.channel.Channel 继承的字段
OP_NONE, OP_READ, OP_READ_WRITE, OP_WRITE
 
方法摘要
 ChannelFuture bind(java.net.SocketAddress localAddress)
          异步绑定该通道到指定的本地地址.
 ChannelFuture close()
          异步关闭通道.如果该通道已经绑定或连接,则会先断开连接和取消绑定.一旦该通道被关闭,将不能再次打开.在一个关闭的通道调用该方法不会有任何效果.
 int compareTo(Channel o)
          比较两个通道的ID.
 ChannelFuture connect(java.net.SocketAddress remoteAddress)
          异步连接该通道到指定的远程地址.
 ChannelFuture disconnect()
          异步从当前远程地址断开连接.
 boolean equals(java.lang.Object o)
          只有当指定的对象与该对象相同时返回true(如: this == o).
 ChannelFuture getCloseFuture()
          返回一个当通道被关闭会接收通知的ChannelFuture.
 ChannelFactory getFactory()
          返回创建该通道的ChannelFactory.
 java.lang.Integer getId()
          返回该通道唯一的整型ID.
 int getInterestOps()
          返回该通道当前的interestOps.
 Channel getParent()
          返回该通道的父通道.
 ChannelPipeline getPipeline()
          返回连接该通道用来处理ChannelEvent事件的ChannelPipeline.
 int hashCode()
          返回该通道的哈希标识 .
 boolean isOpen()
          只有当该通道是打开的才返回true.
 boolean isReadable()
          只有当I/O线程可以从该通道读取消息时才返回true.该方法是以下代码的快捷方式: return (getInterestOps() & OP_READ) !
 boolean isWritable()
          只有当I/O线程可以执行请求立即写操作时才返回true.当该方法返回false时任何写操作都会被排队直到I/O线程准备处理队列的写请求为止.
 ChannelFuture setInterestOps(int interestOps)
          异步改变该通道的interestOps.
 ChannelFuture setReadable(boolean readable)
          异步挂起或恢复I/O线程的读操作.该方法是以下代码的快捷方式: int interestOps = getInterestOps(); if (readable) { setInterestOps(interestOps | OP_READ); } else { setInterestOps(interestOps & ˜OP_READ); }
 java.lang.String toString()
          返回该缓冲的字符串形式.为了更简单标识,返回的字符串包含了该缓冲的 ID, 本地地址,和 远程地址.
 ChannelFuture unbind()
          异步取消与当前本地地址的绑定.
 ChannelFuture write(java.lang.Object message)
          异步返送消息到该通道.如果该通道是使用无连接传输创建的(如.
 ChannelFuture write(java.lang.Object message, java.net.SocketAddress remoteAddress)
          异步发送消息到该通道.它有一个附加的参数允许用户使用指定的远程地址代替当前远程地址来发送消息.
 
从类 java.lang.Object 继承的方法
getClass, notify, notifyAll, wait, wait, wait
 
从接口 org.jboss.netty.channel.Channel 继承的方法
getConfig, getLocalAddress, getRemoteAddress, isBound, isConnected
 

方法详细信息

getId

public final java.lang.Integer getId()
从接口 Channel 复制的描述
返回该通道唯一的整型ID.

指定者:
接口 Channel 中的 getId

getParent

public Channel getParent()
从接口 Channel 复制的描述
返回该通道的父通道.

指定者:
接口 Channel 中的 getParent
返回:
父通道. 如果该通道没有父通道则返回null.

getFactory

public ChannelFactory getFactory()
从接口 Channel 复制的描述
返回创建该通道的ChannelFactory.

指定者:
接口 Channel 中的 getFactory

getPipeline

public ChannelPipeline getPipeline()
从接口 Channel 复制的描述
返回连接该通道用来处理ChannelEvent事件的ChannelPipeline.

指定者:
接口 Channel 中的 getPipeline

hashCode

public final int hashCode()
返回该通道的哈希标识 .

覆盖:
java.lang.Object 中的 hashCode

equals

public final boolean equals(java.lang.Object o)
只有当指定的对象与该对象相同时返回true(如: this == o).

覆盖:
java.lang.Object 中的 equals

compareTo

public final int compareTo(Channel o)
比较两个通道的ID.

指定者:
接口 java.lang.Comparable<Channel> 中的 compareTo

isOpen

public boolean isOpen()
从接口 Channel 复制的描述
只有当该通道是打开的才返回true.

指定者:
接口 Channel 中的 isOpen

bind

public ChannelFuture bind(java.net.SocketAddress localAddress)
从接口 Channel 复制的描述
异步绑定该通道到指定的本地地址.

指定者:
接口 Channel 中的 bind
参数:
localAddress - 绑定地址
返回:
返回当绑定成功或失败时能接收到通知的ChannelFuture

unbind

public ChannelFuture unbind()
从接口 Channel 复制的描述
异步取消与当前本地地址的绑定.

指定者:
接口 Channel 中的 unbind
返回:
返回当取消绑定成功或失败时能接收到通知的ChannelFuture

close

public ChannelFuture close()
从接口 Channel 复制的描述
异步关闭通道.如果该通道已经绑定或连接,则会先断开连接和取消绑定.一旦该通道被关闭,将不能再次打开.在一个关闭的通道调用该方法不会有任何效果. 请注意该方法总是返回相同的future实例.

指定者:
接口 Channel 中的 close
返回:
返回当关闭成功或失败时能接收到通知的ChannelFuture

getCloseFuture

public ChannelFuture getCloseFuture()
从接口 Channel 复制的描述
返回一个当通道被关闭会接收通知的ChannelFuture. 该方法总是返回相同的future实例.

指定者:
接口 Channel 中的 getCloseFuture

connect

public ChannelFuture connect(java.net.SocketAddress remoteAddress)
从接口 Channel 复制的描述
异步连接该通道到指定的远程地址.

指定者:
接口 Channel 中的 connect
参数:
remoteAddress - 连接的远程地址
返回:
返回当连接请求成功或失败时能接收到通知的ChannelFuture

disconnect

public ChannelFuture disconnect()
从接口 Channel 复制的描述
异步从当前远程地址断开连接.

指定者:
接口 Channel 中的 disconnect
返回:
返回当断开连接请求成功或失败时能接收到通知的ChannelFuture

getInterestOps

public int getInterestOps()
从接口 Channel 复制的描述
返回该通道当前的interestOps.

指定者:
接口 Channel 中的 getInterestOps
返回:
Channel.OP_NONE, Channel.OP_READ, Channel.OP_WRITE, 或 Channel.OP_READ_WRITE

setInterestOps

public ChannelFuture setInterestOps(int interestOps)
从接口 Channel 复制的描述
异步改变该通道的interestOps.

指定者:
接口 Channel 中的 setInterestOps
参数:
interestOps - 新的interestOps
返回:
返回当interestOps改变成功或失败时能接收到通知的ChannelFuture

isReadable

public boolean isReadable()
从接口 Channel 复制的描述
只有当I/O线程可以从该通道读取消息时才返回true.该方法是以下代码的快捷方式:
 return (getInterestOps() & OP_READ) != 0;
 

指定者:
接口 Channel 中的 isReadable

isWritable

public boolean isWritable()
从接口 Channel 复制的描述
只有当I/O线程可以执行请求立即写操作时才返回true.当该方法返回false时任何写操作都会被排队直到I/O线程准备处理队列的写请求为止. 该方法是以下代码的快捷方式:
 return (getInterestOps() & OP_WRITE) == 0;
 

指定者:
接口 Channel 中的 isWritable

setReadable

public ChannelFuture setReadable(boolean readable)
从接口 Channel 复制的描述
异步挂起或恢复I/O线程的读操作.该方法是以下代码的快捷方式:
 int interestOps = getInterestOps();
 if (readable) {
        setInterestOps(interestOps | OP_READ);
 } else {
        setInterestOps(interestOps & ˜OP_READ);
 }
 

指定者:
接口 Channel 中的 setReadable
参数:
readable - true则为恢复读操作,false为挂起读操作
返回:
返回当interestOps改变成功或失败时能接收到通知的ChannelFuture

write

public ChannelFuture write(java.lang.Object message)
从接口 Channel 复制的描述
异步返送消息到该通道.如果该通道是使用无连接传输创建的(如. DatagramChannel)并且还没有连接, 你必须使用 Channel.write(Object, SocketAddress)代替.否则,写请求会抛出 NotYetConnectedException并且'exceptionCaught'事件会被触发.

指定者:
接口 Channel 中的 write
参数:
message - 要写的消息
返回:
返回当写请求成功或失败时能接收到通知的ChannelFuture

write

public ChannelFuture write(java.lang.Object message,
                           java.net.SocketAddress remoteAddress)
从接口 Channel 复制的描述
异步发送消息到该通道.它有一个附加的参数允许用户使用指定的远程地址代替当前远程地址来发送消息. 如果该通道是使用无连接传输(如. DatagramChannel)创建且还没有连接,你必须指定一个非空的地址.否则,写请求会抛出 NotYetConnectedException并且'exceptionCaught'事件会被触发.

指定者:
接口 Channel 中的 write
参数:
message - 要写的消息
remoteAddress - 消息要发送的远程地址.如果为null,则和方法Channel.write(Object)相同.
返回:
返回当写请求成功或失败时能接收到通知的ChannelFuture

toString

public java.lang.String toString()
返回该缓冲的字符串形式.为了更简单标识,返回的字符串包含了该缓冲的 ID, 本地地址,和 远程地址.

覆盖:
java.lang.Object 中的 toString