com.baidu.bigpipe.transport.pub

类 AbstractNioSession

java.lang.Object

com.baidu.bigpipe.transport.BigpipeSessionSupport

com.baidu.bigpipe.transport.pub.AbstractNioSession

直接已知子类:

AbstractNioPublisher

public abstract class AbstractNioSession
extends BigpipeSessionSupport

基于nio单线程单tcp通信的基类，它实现了大部分与通信相关的逻辑，比如构建tcpchannel，selector，开启线程， 发送接收数据等。采用模板方法设计模式，与业务相关的逻辑被抽象成各种抽象方法，延迟到具体子类实现。

作者:

hexiufeng

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static class	AbstractNioSession.AttachHolder 绑定在SocketKey上的任务占位符,它作为SocketKey的attachment而存在，是可以被重用的， 它包含需要发送的任务和需要被接收数据的上下文，在双工模式下二者是没有任何关联关系的

从类继承的嵌套类/接口 com.baidu.bigpipe.transport.BigpipeSessionSupport

BigpipeSessionSupport.PIPE_TYPE

字段概要

字段

限定符和类型	字段和说明
protected boolean	duplexMode 是否采用tcp的双工模式
protected int	publisherTryMaxCount
protected Selector	selector
protected int	selecttimeout
protected com.baidu.bigpipe.transport.pub.AbstractNioSession.SessionRuntime	sessionRuntime 当前session的运行时状态
protected SocketConf	socketConf socket连接的配置信息
protected SocketChannel	tcpConnect
protected AtomicBoolean	wakenUp copy from netty, 用于防止频繁的selector.wakeup

从类继承的字段 com.baidu.bigpipe.transport.BigpipeSessionSupport

lifeController, pipeRuntime, reciever

构造器概要

构造器

构造器和说明
AbstractNioSession()

方法概要

方法

限定符和类型	方法和说明
protected abstract void	configTask(WriteTask task, boolean isNeedTcp) config Task
protected void	continueConfig(BigPipeConf conf) 继续应用配置信息，允许子类从BigPipeConf获取私有配置信息并应用
protected abstract void	ensureTcp() 保证构建tcp连接
int	getPublisherTryMaxCount()
Receiver	getReciever()
SocketConf	getSocketConf()
protected abstract void	handleSelectorException(SelectionKey key) 当读写tcp出现异常时调用该方法来处理异常，一般来说如果有的任务处理出现异常，需要把任务恢复初始状态 然后关闭对应的channel
protected abstract void	handleShutDown() 当任何调用方调用 shutdown 方法后，需要做的善后工作
protected abstract void	handleTimeout() 探测当前是否有任务已经timeout，如果有需要处理这些超时任务
boolean	isDuplexMode()
protected TopicAddress	lookupAddr(NameService ns, String pipeletName) 从zk中根据pipeletName获取实例地址
protected abstract ReadState	read(SelectionKey k) 从tcp channel中读取数据
protected void	safeCloseTcpConnect() 封装关闭tcp channel，隐藏异常处理细节
void	setDuplexMode(boolean duplexMode)
void	setPublisherTryMaxCount(int publisherTryMaxCount)
void	setReciever(Receiver reciever)
void	setSocketConf(SocketConf socketConf)
void	shutDown() 关闭当前session，如果有未执行完成的任务，会放弃执行并返回给调用方执行失败信息
void	start(BigPipeConf conf) 开启selector.select线程
protected abstract WriteTask	startNewTask() 获取下一个需要处理的新任务
protected void	tryToStartNewTask() 尝试获取下一个需要处理的任务，并且开时处理这个任务
protected abstract WriteState	write(SelectionKey k) 向tcp channel中写入数据

从类继承的方法 com.baidu.bigpipe.transport.BigpipeSessionSupport

buildConnect, getPipeletOrQueueName, getType, handleFastFailed, init, openStream, setType, waitingForConnect

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

duplexMode

protected boolean duplexMode

是否采用tcp的双工模式

selector

protected volatile Selector selector

wakenUp

protected AtomicBoolean wakenUp

copy from netty, 用于防止频繁的selector.wakeup

selecttimeout

protected volatile int selecttimeout

publisherTryMaxCount

protected int publisherTryMaxCount

sessionRuntime

protected final com.baidu.bigpipe.transport.pub.AbstractNioSession.SessionRuntime sessionRuntime

当前session的运行时状态

tcpConnect

protected volatile SocketChannel tcpConnect

socketConf

protected volatile SocketConf socketConf

socket连接的配置信息

构造器详细资料

AbstractNioSession

public AbstractNioSession()

方法详细资料

getSocketConf

public SocketConf getSocketConf()

setSocketConf

public void setSocketConf(SocketConf socketConf)

getReciever

public Receiver getReciever()

setReciever

public void setReciever(Receiver reciever)

isDuplexMode

public boolean isDuplexMode()

setDuplexMode

public void setDuplexMode(boolean duplexMode)

getPublisherTryMaxCount

public int getPublisherTryMaxCount()

setPublisherTryMaxCount

public void setPublisherTryMaxCount(int publisherTryMaxCount)

shutDown

public void shutDown()

关闭当前session，如果有未执行完成的任务，会放弃执行并返回给调用方执行失败信息

continueConfig

protected void continueConfig(BigPipeConf conf)

从类复制的说明: BigpipeSessionSupport

继续应用配置信息，允许子类从BigPipeConf获取私有配置信息并应用

指定者:

continueConfig 在类中 BigpipeSessionSupport

参数:

conf - BigPipeConf 配置信息

lookupAddr

protected TopicAddress lookupAddr(NameService ns,
                      String pipeletName)
                           throws NameResolveException,
                                  org.apache.zookeeper.KeeperException

从类复制的说明: BigpipeSessionSupport

从zk中根据pipeletName获取实例地址

指定者:

lookupAddr 在类中 BigpipeSessionSupport

参数:

ns - NameService对象

pipeletName - pipelet Name or queue Name

返回:

InetAddress

抛出:

NameResolveException - 根据名字解析TopicAddress QueueAddress异常

org.apache.zookeeper.KeeperException - zk异常

handleSelectorException

protected abstract void handleSelectorException(SelectionKey key)

当读写tcp出现异常时调用该方法来处理异常，一般来说如果有的任务处理出现异常，需要把任务恢复初始状态 然后关闭对应的channel

参数:

key -

handleTimeout

protected abstract void handleTimeout()

探测当前是否有任务已经timeout，如果有需要处理这些超时任务

write

protected abstract WriteState write(SelectionKey k)

向tcp channel中写入数据

参数:

k - SelectionKey对象

返回:

WriteState

read

protected abstract ReadState read(SelectionKey k)

从tcp channel中读取数据

参数:

k - SelectionKey对象

返回:

ReadState

startNewTask

protected abstract WriteTask startNewTask()

获取下一个需要处理的新任务

返回:

WriteTask

configTask

protected abstract void configTask(WriteTask task,
              boolean isNeedTcp)

config Task

参数:

task - task

isNeedTcp - isNeedTcp

ensureTcp

protected abstract void ensureTcp()

保证构建tcp连接

handleShutDown

protected abstract void handleShutDown()

当任何调用方调用 shutdown 方法后，需要做的善后工作

start

public final void start(BigPipeConf conf)

开启selector.select线程

指定者:

start 在类中 BigpipeSessionSupport

参数:

conf - 配置

safeCloseTcpConnect

protected final void safeCloseTcpConnect()

封装关闭tcp channel，隐藏异常处理细节

指定者:

safeCloseTcpConnect 在类中 BigpipeSessionSupport

tryToStartNewTask

protected void tryToStartNewTask()

尝试获取下一个需要处理的任务，并且开时处理这个任务