|
|||||||||
上一个类 下一个类 | 框架 无框架 | ||||||||
摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 |
public interface ChannelPipeline
处理或拦截一个Channel
的ChannelEvent
的ChannelHandler
列表.
ChannelPipeline
实现了拦截过滤器模式的高级形式让用户在一个事件如何被处理以及管道里ChannelHandler
之间如何交互上提供了了全方位控制.
创建管道的推荐方式是使用Channels
里的帮助方法而不是调用独立实现的构造方法:
import static org.jboss.netty.channel.Channels
.*;ChannelPipeline
pipeline = pipeline(); // 与 Channels.pipeline()相同
ChannelPipeline
里的ChannelHandler
如何处理
ChannelEvent
.一个ChannelEvent
要么被ChannelUpstreamHandler
处理要么被ChannelDownstreamHandler
处理以及通过调用
ChannelHandlerContext.sendUpstream(ChannelEvent)
或
ChannelHandlerContext.sendDownstream(ChannelEvent)
被转发到最接近的处理器.意味着事件被解析有多少不同依赖于它是上游事件还是下游事件.请参考ChannelEvent
了解更多信息.
I/O Request via从图的左边可以知道一个上游事件处理是由下往上方向的.一个上游处理器通常处理由图下方的I/O线程产生的入站数据. 入站数据通常是读取远程端通过实际输入操作的数据如Channel
orChannelHandlerContext
| +----------------------------------------+---------------+ | ChannelPipeline | | | \|/ | | +----------------------+ +-----------+------------+ | | | Upstream Handler N | | Downstream Handler 1 | | | +----------+-----------+ +-----------+------------+ | | /|\ | | | | \|/ | | +----------+-----------+ +-----------+------------+ | | | Upstream Handler N-1 | | Downstream Handler 2 | | | +----------+-----------+ +-----------+------------+ | | /|\ . | | . . | | [ sendUpstream() ] [ sendDownstream() ] | | [ + INBOUND data ] [ + OUTBOUND data ] | | . . | | . \|/ | | +----------+-----------+ +-----------+------------+ | | | Upstream Handler 2 | | Downstream Handler M-1 | | | +----------+-----------+ +-----------+------------+ | | /|\ | | | | \|/ | | +----------+-----------+ +-----------+------------+ | | | Upstream Handler 1 | | Downstream Handler M | | | +----------+-----------+ +-----------+------------+ | | /|\ | | +-------------+--------------------------+---------------+ | \|/ +-------------+--------------------------+---------------+ | | | | | [ Socket.read() ] [ Socket.write() ] | | | | Netty Internal I/O Threads (Transport Implementation) | +--------------------------------------------------------+
InputStream.read(byte[])
.如果一个上游事件超过了顶部上游处理器,则会被悄悄的丢弃.
从图的右边可以知道一个下游事件处理是由上往下方向的.一个下游处理器通常是产生或转换出站流量如写请求.如果一个下游事件超过了底部下游处理器,它会被关联
Channel
的I/O线程处理.这个I/O线程通常执行实际的输出操作如OutputStream.write(byte[])
.
例如,我们假设我们创建了以下管道:
在上面的例子,名字以ChannelPipeline
p =Channels
.pipeline(); p.addLast("1", new UpstreamHandlerA()); p.addLast("2", new UpstreamHandlerB()); p.addLast("3", new DownstreamHandlerA()); p.addLast("4", new DownstreamHandlerB()); p.addLast("5", new UpstreamHandlerX());
Upstream
开头的类是一个上游处理器.名字以Downstream
开头的类是一个下游处理器.
如给的例子配置,当一个事件上游的处理顺序是1, 2, 3, 4, 5.当一个事件下游,顺序是5, 4, 3, 2, 1.在上面的原则上,
ChannelPipeline
会跳过某些处理器的计算以缩短栈的深度:
ChannelUpstreamHandler
,因此一个上游事件的实际计算顺序是: 1, 2, 5.ChannelDownstreamHandler
,因此一个下游事件的实际计算顺序是: 4,3.ChannelUpstreamHandler
和ChannelDownstreamHandler
的SimpleChannelHandler
,上下游的计算顺序分别是125和543.
一个用户被假定在一个管道里有一个或多个ChannelHandler
用来接收I/O事件(如. read)和请求I/O操作(如. write
and close).例如,一个典型的服务器在每个通道的管道里有以下处理器,但你的里程可能是多变的,这依赖于复杂性和协议的特性及业务逻辑:
ChannelBuffer
)为一个Java对象.ExecutionHandler
- 应用一个线程模型.ChannelPipeline
pipeline =Channels.pipeline()
; pipeline.addLast("decoder", new MyProtocolDecoder()); pipeline.addLast("encoder", new MyProtocolEncoder()); pipeline.addLast("executor", newExecutionHandler
(newOrderedMemoryAwareThreadPoolExecutor
(16, 1048576, 1048576))); pipeline.addLast("handler", new MyBusinessLogicHandler());
一个ChannelHandler
可以在任何时候被添加或删除,因为ChannelPipeline
是线程安全的.例如,当敏感信息被交换和交换后移除时你可以插入一个SslHandler
.
因为当前默认ChannelPipeline
的内部详细实现,如果以下代码管道里的FirstHandler
是最后一个处理器,那么代码不能如愿工作:
public class FirstHandler extends要如愿实现行为,你必须在移除之前添加SecondHandler或确保在FirstHandler和 SecondHandler之间至少有一个处理器.SimpleChannelUpstreamHandler
{@Override
public void messageReceived(ChannelHandlerContext
ctx,MessageEvent
e) { // 从管道里移除处理器, ctx.getPipeline().remove(this); // 并让SecondHandler处理当前事件. ctx.getPipeline().addLast("2nd", new SecondHandler()); ctx.sendUpstream(e); } }
方法摘要 | ||
---|---|---|
void |
addAfter(java.lang.String baseName,
java.lang.String name,
ChannelHandler handler)
在管道里已存在处理器之后插入 ChannelHandler . |
|
void |
addBefore(java.lang.String baseName,
java.lang.String name,
ChannelHandler handler)
在管道已存在处理器前插入 ChannelHandler . |
|
void |
addFirst(java.lang.String name,
ChannelHandler handler)
在管道第一个位置插入 ChannelHandler . |
|
void |
addLast(java.lang.String name,
ChannelHandler handler)
在管道最后位置插入 ChannelHandler . |
|
void |
attach(Channel channel,
ChannelSink sink)
附加该管道到一个指定的 Channel 和ChannelSink .一旦一个管道被附加,就不能分离或重新附加. |
|
|
get(java.lang.Class<T> handlerType)
返回管道里指定类型的 ChannelHandler . |
|
ChannelHandler |
get(java.lang.String name)
返回管道里指定名称的 ChannelHandler . |
|
Channel |
getChannel()
返回该管道被附加的 Channel . |
|
ChannelHandlerContext |
getContext(ChannelHandler handler)
返回管道里指定 ChannelHandler 的上下文对象. |
|
ChannelHandlerContext |
getContext(java.lang.Class<? extends ChannelHandler> handlerType)
返回在该管道里指定类型的 ChannelHandler 的上下文对象. |
|
ChannelHandlerContext |
getContext(java.lang.String name)
返回在该管道里指定名字的 ChannelHandler 的上下文对象. |
|
ChannelHandler |
getFirst()
返回该管道的第一个 ChannelHandler . |
|
ChannelHandler |
getLast()
返回管道里最后一个 ChannelHandler . |
|
ChannelSink |
getSink()
返回该管道被附加的 ChannelSink . |
|
boolean |
isAttached()
只有当该管道被附加到一个 Channel 才返回true . |
|
void |
remove(ChannelHandler handler)
移除管道里指定的 ChannelHandler . |
|
|
remove(java.lang.Class<T> handlerType)
移除该管道里指定类型的 ChannelHandler |
|
ChannelHandler |
remove(java.lang.String name)
移除该管道里指定名称的 ChannelHandler |
|
ChannelHandler |
removeFirst()
移除管道第一个 ChannelHandler . |
|
ChannelHandler |
removeLast()
移除管道最后一个 ChannelHandler . |
|
void |
replace(ChannelHandler oldHandler,
java.lang.String newName,
ChannelHandler newHandler)
使用指定处理器替换管道里指定的 ChannelHandler . |
|
|
replace(java.lang.Class<T> oldHandlerType,
java.lang.String newName,
ChannelHandler newHandler)
使用指定处理器替换管道里指定类型的 ChannelHandler . |
|
ChannelHandler |
replace(java.lang.String oldName,
java.lang.String newName,
ChannelHandler newHandler)
使用指定处理器替换管道里指定名称的 ChannelHandler . |
|
void |
sendDownstream(ChannelEvent e)
发送指定的 ChannelEvent 到该管道最后一个的ChannelDownstreamHandler . |
|
void |
sendUpstream(ChannelEvent e)
发送指定的 ChannelEvent 到该管道第一个的ChannelDownstreamHandler . |
|
java.util.Map<java.lang.String,ChannelHandler> |
toMap()
转化该管道为一个key为处理器名、value为处理器的有序 Map . |
方法详细信息 |
---|
void addFirst(java.lang.String name, ChannelHandler handler)
ChannelHandler
.
name
- 插入处理器的名字handler
- 要插入的处理器
java.lang.IllegalArgumentException
- 如果管道里有名字相同的实体存在则抛出异常
java.lang.NullPointerException
- 如果指定的名字或处理器是null
则抛出异常void addLast(java.lang.String name, ChannelHandler handler)
ChannelHandler
.
name
- 插入处理器的名字handler
- 要插入的处理器
java.lang.IllegalArgumentException
- 如果管道里有名字相同的实体存在则抛出异常
java.lang.NullPointerException
- 如果指定的名字或处理器是null
则抛出异常void addBefore(java.lang.String baseName, java.lang.String name, ChannelHandler handler)
ChannelHandler
.
baseName
- 原存在处理器名称name
- 要插入处理器的名称handler
- 要插入的处理
java.util.NoSuchElementException
- 如果没有指定名称的实体存在则抛出异常
java.lang.IllegalArgumentException
- 如果管道里有名字相同的实体存在则抛出异常
java.lang.NullPointerException
- 如果指定的basename,name或处理器是null
则抛出异常void addAfter(java.lang.String baseName, java.lang.String name, ChannelHandler handler)
ChannelHandler
.
baseName
- 存在的处理器名称name
- 插入到该名称的处理器的后面handler
- 要插入的处理器
java.util.NoSuchElementException
- 如果没有指定名称的实体存在则抛出异常
java.lang.IllegalArgumentException
- 如果管道里有名字相同的实体存在则抛出异常
java.lang.NullPointerException
- 如果指定的basename,name或处理器是null
则抛出异常void remove(ChannelHandler handler)
ChannelHandler
.
java.util.NoSuchElementException
- 如果该管道里没有该处理器则抛出异常
java.lang.NullPointerException
- 如果指定的处理器为null
则抛出异常ChannelHandler remove(java.lang.String name)
ChannelHandler
java.util.NoSuchElementException
- 如果管道里没有指定类型的处理器则抛出异常
java.lang.NullPointerException
- 如果指定的处理器为null
则抛出异常<T extends ChannelHandler> T remove(java.lang.Class<T> handlerType)
ChannelHandler
T
- 处理器类型handlerType
- 处理器类型
java.util.NoSuchElementException
- 如果管道里没有指定类型的处理器则抛出异常
java.lang.NullPointerException
- 如果指定的处理器为null
则抛出异常ChannelHandler removeFirst()
ChannelHandler
.
java.util.NoSuchElementException
- 如果管道为空则抛出异常ChannelHandler removeLast()
ChannelHandler
.
java.util.NoSuchElementException
- 如果管道为空则抛出异常void replace(ChannelHandler oldHandler, java.lang.String newName, ChannelHandler newHandler)
ChannelHandler
.
java.util.NoSuchElementException
- 如果该管道里没有指定的旧的处理器则抛出异常
java.lang.IllegalArgumentException
- 如果该管道已经存在指定新名称的处理器,除了要替换的处理器则抛出异常
java.lang.NullPointerException
- 如果指定的旧的处理、新名称或新处理器为null
则抛出异常ChannelHandler replace(java.lang.String oldName, java.lang.String newName, ChannelHandler newHandler)
ChannelHandler
.
java.util.NoSuchElementException
- 如果该管道里没有指定的旧的处理器名称的处理器则抛出异常
java.lang.IllegalArgumentException
- 如果该管道已经存在指定新名称的处理器,除了要替换的处理器则抛出异常
java.lang.NullPointerException
- 如果指定的旧的处理、新名称或新处理器为null
则抛出异常<T extends ChannelHandler> T replace(java.lang.Class<T> oldHandlerType, java.lang.String newName, ChannelHandler newHandler)
ChannelHandler
.
java.util.NoSuchElementException
- 如果该管道里没有指定的旧的处理器类型的处理器则抛出异常
java.lang.IllegalArgumentException
- 如果该管道已经存在指定新名称的处理器,除了要替换的处理器则抛出异常
java.lang.NullPointerException
- 如果指定的旧的处理、新名称或新处理器为null
则抛出异常ChannelHandler getFirst()
ChannelHandler
.
null
.ChannelHandler getLast()
ChannelHandler
.
null
.ChannelHandler get(java.lang.String name)
ChannelHandler
.
null
.<T extends ChannelHandler> T get(java.lang.Class<T> handlerType)
ChannelHandler
.
null
.ChannelHandlerContext getContext(ChannelHandler handler)
ChannelHandler
的上下文对象.
null
.ChannelHandlerContext getContext(java.lang.String name)
ChannelHandler
的上下文对象.
null
.ChannelHandlerContext getContext(java.lang.Class<? extends ChannelHandler> handlerType)
ChannelHandler
的上下文对象.
ChannelHandler
的上下文对象. 如果在该管道里没有该处理器则返回null
.void sendUpstream(ChannelEvent e)
ChannelEvent
到该管道第一个的ChannelDownstreamHandler
.
java.lang.NullPointerException
- 如果指定的事件为null
则抛出异常void sendDownstream(ChannelEvent e)
ChannelEvent
到该管道最后一个的ChannelDownstreamHandler
.
java.lang.NullPointerException
- 如果指定的事件为null
则抛出异常Channel getChannel()
Channel
.
null
.ChannelSink getSink()
ChannelSink
.
null
.void attach(Channel channel, ChannelSink sink)
Channel
和ChannelSink
.一旦一个管道被附加,就不能分离或重新附加.
java.lang.IllegalStateException
- 如果该管道已经被附加则抛出异常boolean isAttached()
Channel
才返回true
.
java.util.Map<java.lang.String,ChannelHandler> toMap()
Map
.
|
|||||||||
上一个类 下一个类 | 框架 无框架 | ||||||||
摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 |