IoSession (Voovan-码云(gitee.com))

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

Direct Known Subclasses:

TcpSession, UdpSession
```
public abstract class IoSession<T extends SocketContext>
extends Attributes
```
会话抽象类

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`
`static HashWheelTimer`	`SOCKET_IDLE_WHEEL_TIME`

Constructor Summary

Constructors
Constructor and Description

IoSession(T socketContext)
构造函数

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancelIdle()` 停止空闲事件触发
`void`	`checkIdle()` 启动空闲事件触发
`abstract boolean`	`close()` 关闭会话
`void`	`flush()` 推送缓冲区的数据到 socketChannel
`Object`	`getAttachment()`
`protected EventRunner`	`getEventRunner()` 获取 Event 执行器
`HeartBeat`	`getHeartBeat()` 获取心跳对象
`int`	`getIdleInterval()` 获取空闲事件时间
`static HashWheelTimer`	`getIdleWheelTimer()`
`MessageLoader`	`getMessageLoader()` 获取消息处理类
`protected abstract MessageSplitter`	`getMessageSplitter()` 获取消息分割处理类
`ByteBufferChannel`	`getReadByteBufferChannel()` 获取读取缓冲区
`protected SelectionKey`	`getSelectionKey()` 获取 SelectionKey
`ByteBufferChannel`	`getSendByteBufferChannel()` 获取发送缓冲区
`SocketSelector`	`getSocketSelector()` 获取 Socket 选择器
`SSLParser`	`getSSLParser()` 获取 SSLParser
`IoSession.State`	`getState()` 获取状态
`abstract boolean`	`isConnected()` 会话是否连接
`abstract boolean`	`isOpen()` 会话是否打开
`boolean`	`isSSLMode()`
`abstract int`	`loaclPort()` 获取本地端口
`abstract String`	`localAddress()` 获取本地 IP 地址
`int`	`read(ByteBuffer byteBuffer)` 直接从缓冲区读取数据
`protected int`	`read0()` 读取消息到缓冲区
`void`	`release()`
`abstract String`	`remoteAddress()` 获取对端 IP 地址
`abstract int`	`remotePort()` 获取对端端口
`int`	`send(ByteBuffer buffer)` 直接向缓冲区发送消息注意直接调用不会触发 onSent 事件, 也不会经过任何过滤器
`protected int`	`send0(ByteBuffer buffer)` 发送消息到 JVM 的 SocketChannel 注意直接调用不会出发 onSent 事件
`protected int`	`sendToBuffer(ByteBuffer buffer)` 发送消息到发送缓冲区
`void`	`setAttachment(Object attachment)`
`void`	`setIdleInterval(int idleInterval)` 设置空闲事件时间
`protected void`	`setSocketSelector(SocketSelector socketSelector)` 设置 Socket 选择器
`protected void`	`setSSLParser(SSLParser sslParser)` 获取 SSLParser
`T`	`socketContext()` 获取 socket 连接上下文
`Object`	`syncRead()` 同步读取消息消息会经过 filter 的 decoder 函数处理后再返回
`void`	`syncSend(Object obj)` 同步发送消息消息会经过 filter 的 encoder 函数处理后再发送
`abstract String`	`toString()`

Methods inherited from class org.voovan.tools.collection.Attributes
attributes, clearAttribute, containAttribute, getAttribute, isModifyed, removeAttribute, setAttribute, setModifyed

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

- Field Detail
  - SOCKET_IDLE_WHEEL_TIME
```
public static HashWheelTimer SOCKET_IDLE_WHEEL_TIME
```
  - readByteBufferChannel
```
protected ByteBufferChannel readByteBufferChannel
```
  - sendByteBufferChannel
```
protected ByteBufferChannel sendByteBufferChannel
```
- Constructor Detail
  - IoSession
```
public IoSession(T socketContext)
```
    构造函数
    
    Parameters:
    
    socketContext - socketContext对象
- Method Detail
  - getIdleWheelTimer
```
public static HashWheelTimer getIdleWheelTimer()
```
  - getAttachment
```
public Object getAttachment()
```
  - setAttachment
```
public void setAttachment(Object attachment)
```
  - getSocketSelector
```
public SocketSelector getSocketSelector()
```
    获取 Socket 选择器
    
    Returns:
    
    Socket 选择器
  - setSocketSelector
```
protected void setSocketSelector(SocketSelector socketSelector)
```
    设置 Socket 选择器
    
    Parameters:
    
    socketSelector - Socket 选择器
  - getEventRunner
```
protected EventRunner getEventRunner()
```
    获取 Event 执行器
    
    Returns:
    
    Event 执行器
  - getSelectionKey
```
protected SelectionKey getSelectionKey()
```
    获取 SelectionKey
    
    Returns:
    
    SelectionKey 对象
  - getHeartBeat
```
public HeartBeat getHeartBeat()
```
    获取心跳对象
    
    Returns:
    
    心跳对象
  - getState
```
public IoSession.State getState()
```
    获取状态
    
    Returns:
    
    当前状态
  - 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解析对象
  - isSSLMode
```
public boolean isSSLMode()
```
  - 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
  - read0
```
protected int read0()
             throws IOException
```
    读取消息到缓冲区
    
    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 int send0(ByteBuffer buffer)
```
    发送消息到 JVM 的 SocketChannel 注意直接调用不会出发 onSent 事件
    
    Parameters:
    
    buffer - 发送缓冲区
    
    Returns:
    
    读取的字节数
  - sendToBuffer
```
protected int sendToBuffer(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:
    
    消息处理类
  - getMessageSplitter
```
protected abstract MessageSplitter getMessageSplitter()
```
    获取消息分割处理类
    
    Returns:
    
    消息分割处理类
  - isConnected
```
public abstract boolean isConnected()
```
    会话是否连接
    
    Returns:
    
    true: 连接,false: 关闭
  - isOpen
```
public abstract boolean isOpen()
```
    会话是否打开
    
    Returns:
    
    true: 打开,false: 关闭
  - close
```
public abstract boolean close()
```
    关闭会话
    
    Returns:
    
    是否关闭
  - release
```
public void release()
```
  - 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 org.voovan.tools.collection.Attributes

Methods inherited from class java.lang.Object

Field Detail

SOCKET_IDLE_WHEEL_TIME

readByteBufferChannel

sendByteBufferChannel

Constructor Detail

IoSession

Method Detail

getIdleWheelTimer

getAttachment

setAttachment

getSocketSelector

setSocketSelector

getEventRunner

getSelectionKey

getHeartBeat

getState

checkIdle

cancelIdle

getIdleInterval

setIdleInterval

getReadByteBufferChannel

getSendByteBufferChannel

getSSLParser

setSSLParser

isSSLMode

localAddress

loaclPort

remoteAddress

remotePort

socketContext

read0

read

syncRead

send0

sendToBuffer

syncSend

send

flush

getMessageLoader

getMessageSplitter

isConnected

isOpen

close

release

toString