IoSession (Voovan-network 4.0.6.3 API)

java.lang.Object
- org.voovan.network.IoSession<T>

Direct Known Subclasses:

AioSession, NioSession, UdpSession
```
public abstract class IoSession<T extends SocketContext>
extends Object
```
会话抽象类

Author:

helyho Voovan Framework. WebSite: https://github.com/helyho/Voovan Licence: Apache v2 License

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class IoSession.State
会话状态管理

Nested Classes
Modifier and Type	Class and Description
`class`	`IoSession.State` 会话状态管理

Field Summary

Fields
Modifier and Type Field and Description

protected ByteBufferChannel readByteBufferChannel

protected ByteBufferChannel sendByteBufferChannel

Fields
Modifier and Type	Field and Description
`protected ByteBufferChannel`	`readByteBufferChannel`
`protected ByteBufferChannel`	`sendByteBufferChannel`

Constructor Summary

Constructors
Constructor and Description

IoSession(T socketContext)
构造函数

Constructors
Constructor and Description
`IoSession(T socketContext)` 构造函数

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancelIdle()` 停止空闲事件触发
`void`	`checkIdle()` 启动空闲事件触发
`abstract boolean`	`close()` 关闭会话
`boolean`	`containAttribute(Object key)` 检查会话参数是否存在
`void`	`enabledMessageSpliter(boolean useSpliter)` 设置是否使用分割器读取
`void`	`flush()` 推送缓冲区的数据到 socketChannel
`Object`	`getAttribute(Object key)` 获取会话参数
`Map<Object,Object>`	`getAttributes()` 获取全部会话参数
`protected ArrayList<Object>`	`getFlushedObjects()`
`HeartBeat`	`getHeartBeat()` 获取心跳对象
`int`	`getIdleInterval()` 获取空闲事件时间
`MessageLoader`	`getMessageLoader()` 获取消息处理类
`protected abstract MessageSplitter`	`getMessagePartition()` 获取消息分割处理类
`ByteBufferChannel`	`getReadByteBufferChannel()` 获取接收的输出流
`ByteBufferChannel`	`getSendByteBufferChannel()` 获取发送收的输出流
`SSLParser`	`getSSLParser()` 获取 SSLParser
`IoSession.State`	`getState()`
`abstract boolean`	`isConnected()` 会话是否连接
`abstract boolean`	`isOpen()` 会话是否打开
`abstract int`	`loaclPort()` 获取本地端口
`abstract String`	`localAddress()` 获取本地 IP 地址
`int`	`read(ByteBuffer byteBuffer)` 直接从缓冲区读取数据
`protected abstract int`	`read0(ByteBuffer buffer)` 读取消息到缓冲区
`abstract String`	`remoteAddress()` 获取对端 IP 地址
`abstract int`	`remotePort()` 获取对端端口
`void`	`removeAttribute(Object key)` 移除会话参数
`int`	`send(ByteBuffer buffer)` 直接向缓冲区发送消息注意直接调用不会触发 onSent 事件, 也不会经过任何过滤器
`protected abstract int`	`send0(ByteBuffer buffer)` 发送消息注意直接调用不会出发 onSent 事件
`int`	`sendByBuffer(ByteBuffer buffer)` 发送消息到发送缓冲区
`void`	`setAttribute(Object key, Object value)` 设置会话参数
`protected void`	`setFlushedObjects(ArrayList<Object> flushedObjects)`
`protected void`	`setHeartBeat(HeartBeat heartBeat)`
`void`	`setIdleInterval(int idleInterval)` 设置空闲事件时间
`protected void`	`setSSLParser(SSLParser sslParser)` 获取 SSLParser
`T`	`socketContext()` 获取 socket 连接上下文
`Object`	`syncRead()` 同步读取消息消息会经过 filter 的 decoder 函数处理后再返回
`void`	`syncSend(Object obj)` 同步发送消息消息会经过 filter 的 encoder 函数处理后再发送
`abstract String`	`toString()`
`boolean`	`wait(int waitTime)` 等待所有处理都被处理完成 ByteBufferChannel.size() = 0时,或者超时后退出

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - readByteBufferChannel
```
protected ByteBufferChannel readByteBufferChannel
```
  - sendByteBufferChannel
```
protected ByteBufferChannel sendByteBufferChannel
```
- Constructor Detail
  - IoSession
```
public IoSession(T socketContext)
```
    构造函数
    
    Parameters:
    
    socketContext - socketContext对象
- Method Detail
  - getHeartBeat
```
public HeartBeat getHeartBeat()
```
    获取心跳对象
    
    Returns:
    
    心跳对象
  - setHeartBeat
```
protected void setHeartBeat(HeartBeat heartBeat)
```
  - getState
```
public IoSession.State getState()
```
  - checkIdle
```
public void checkIdle()
```
    启动空闲事件触发
  - cancelIdle
```
public void cancelIdle()
```
    停止空闲事件触发
  - getIdleInterval
```
public int getIdleInterval()
```
    获取空闲事件时间
    
    Returns:
    
    空闲事件时间
  - setIdleInterval
```
public void setIdleInterval(int idleInterval)
```
    设置空闲事件时间
    
    Parameters:
    
    idleInterval - 空闲事件时间
  - getReadByteBufferChannel
```
public ByteBufferChannel getReadByteBufferChannel()
```
    获取接收的输出流
    
    Returns:
    
    接收的输出流
  - getSendByteBufferChannel
```
public ByteBufferChannel getSendByteBufferChannel()
```
    获取发送收的输出流
    
    Returns:
    
    发送的输出流
  - getSSLParser
```
public SSLParser getSSLParser()
```
    获取 SSLParser
    
    Returns:
    
    SSLParser对象
  - setSSLParser
```
protected void setSSLParser(SSLParser sslParser)
```
    获取 SSLParser
    
    Parameters:
    
    sslParser - SSL解析对象
  - getAttributes
```
public Map<Object,Object> getAttributes()
```
    获取全部会话参数
    
    Returns:
    
    会话参数Map
  - getAttribute
```
public Object getAttribute(Object key)
```
    获取会话参数
    
    Parameters:
    
    key - 参数名
    
    Returns:
    
    参数对象
  - setAttribute
```
public void setAttribute(Object key,
                         Object value)
```
    设置会话参数
    
    Parameters:
    
    key - 参数名
    
    value - 参数对象
  - removeAttribute
```
public void removeAttribute(Object key)
```
    移除会话参数
    
    Parameters:
    
    key - 参数名
  - containAttribute
```
public boolean containAttribute(Object key)
```
    检查会话参数是否存在
    
    Parameters:
    
    key - 参数名
    
    Returns:
    
    是否包含
  - localAddress
```
public abstract String localAddress()
```
    获取本地 IP 地址
    
    Returns:
    
    本地 IP 地址
  - loaclPort
```
public abstract int loaclPort()
```
    获取本地端口
    
    Returns:
    
    返回-1为没有取到本地端口
  - remoteAddress
```
public abstract String remoteAddress()
```
    获取对端 IP 地址
    
    Returns:
    
    对端 ip 地址
  - remotePort
```
public abstract int remotePort()
```
    获取对端端口
    
    Returns:
    
    返回-1为没有取到对端端口
  - socketContext
```
public T socketContext()
```
    获取 socket 连接上下文
    
    Returns:
    
    socket 连接上下文, 连接断开时返回的是null
  - getFlushedObjects
```
protected ArrayList<Object> getFlushedObjects()
```
  - setFlushedObjects
```
protected void setFlushedObjects(ArrayList<Object> flushedObjects)
```
  - read0
```
protected abstract int read0(ByteBuffer buffer)
                      throws IOException
```
    读取消息到缓冲区
    
    Parameters:
    
    buffer - 接收数据的缓冲区
    
    Returns:
    
    接收数据大小
    
    Throws:
    
    IOException - IO 异常
  - read
```
public int read(ByteBuffer byteBuffer)
         throws IOException
```
    直接从缓冲区读取数据
    
    Parameters:
    
    byteBuffer - 字节缓冲对象ByteBuffer,读取前需要使用 enabledMessageSpliter(false) 停止分割器的工作,除非有特殊的需求.
    
    Returns:
    
    读取的字节数
    
    Throws:
    
    IOException - IO异常
  - syncRead
```
public Object syncRead()
                throws ReadMessageException
```
    同步读取消息消息会经过 filter 的 decoder 函数处理后再返回
    
    Returns:
    
    读取出的对象
    
    Throws:
    
    ReadMessageException - 读取消息异常
  - send0
```
protected abstract int send0(ByteBuffer buffer)
                      throws IOException
```
    发送消息注意直接调用不会出发 onSent 事件
    
    Parameters:
    
    buffer - 发送缓冲区
    
    Returns:
    
    读取的字节数
    
    Throws:
    
    IOException - IO 异常
  - sendByBuffer
```
public int sendByBuffer(ByteBuffer buffer)
```
    发送消息到发送缓冲区
    
    Parameters:
    
    buffer - 发送到缓冲区的 ByteBuffer 对象
    
    Returns:
    
    添加至缓冲区的字节数
  - syncSend
```
public void syncSend(Object obj)
              throws SendMessageException
```
    同步发送消息消息会经过 filter 的 encoder 函数处理后再发送
    
    Parameters:
    
    obj - 要发送的对象
    
    Throws:
    
    SendMessageException - 消息发送异常
  - send
```
public int send(ByteBuffer buffer)
```
    直接向缓冲区发送消息注意直接调用不会触发 onSent 事件, 也不会经过任何过滤器
    
    Parameters:
    
    buffer - byte缓冲区
    
    Returns:
    
    发送的数据大小
  - flush
```
public void flush()
```
    推送缓冲区的数据到 socketChannel
  - getMessageLoader
```
public MessageLoader getMessageLoader()
```
    获取消息处理类
    
    Returns:
    
    消息处理类
  - getMessagePartition
```
protected abstract MessageSplitter getMessagePartition()
```
    获取消息分割处理类
    
    Returns:
    
    消息分割处理类
  - enabledMessageSpliter
```
public void enabledMessageSpliter(boolean useSpliter)
```
    设置是否使用分割器读取
    
    Parameters:
    
    useSpliter - true 使用分割器读取,false 不使用分割器读取,且不会出发 onRecive 事件
  - isConnected
```
public abstract boolean isConnected()
```
    会话是否连接
    
    Returns:
    
    true: 连接,false: 关闭
  - isOpen
```
public abstract boolean isOpen()
```
    会话是否打开
    
    Returns:
    
    true: 打开,false: 关闭
  - wait
```
public boolean wait(int waitTime)
```
    等待所有处理都被处理完成 ByteBufferChannel.size() = 0时,或者超时后退出
    
    Parameters:
    
    waitTime - 超时事件
    
    Returns:
    
    true: 数据处理完退出, false:超时退出
  - close
```
public abstract boolean close()
```
    关闭会话
    
    Returns:
    
    是否关闭
  - toString
```
public abstract String toString()
```
    Overrides:
    
    toString in class Object

Class IoSession<T extends SocketContext>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

readByteBufferChannel

sendByteBufferChannel

Constructor Detail

IoSession

Method Detail

getHeartBeat

setHeartBeat

getState

checkIdle

cancelIdle

getIdleInterval

setIdleInterval

getReadByteBufferChannel

getSendByteBufferChannel

getSSLParser

setSSLParser

getAttributes

getAttribute

setAttribute

removeAttribute

containAttribute

localAddress

loaclPort

remoteAddress

remotePort

socketContext

getFlushedObjects

setFlushedObjects

read0

read

syncRead

send0

sendByBuffer

syncSend

send

flush

getMessageLoader

getMessagePartition

enabledMessageSpliter

isConnected

isOpen

wait

close

toString