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

java.lang.Object
- org.voovan.network.SocketSelector

All Implemented Interfaces:: Closeable, AutoCloseable

public class SocketSelector
extends Object
implements Closeable

选择器

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`isCheckTimeout`
`protected ArraySet<SelectionKey>`	`selectedKeys`
`protected AtomicBoolean`	`selecting`
`protected Selector`	`selector`

Constructor Summary

Constructors
Constructor and Description

SocketSelector(EventRunner eventRunner, boolean isCheckTimeout)
构造方法

Constructors
Constructor and Description
`SocketSelector(EventRunner eventRunner, boolean isCheckTimeout)` 构造方法

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEvent(int priority, Runnable runnable)` 向执行器中增加一个选择事件
`void`	`addIoEvent()` 向执行器中增加一个选择事件
`void`	`checkReadTimeout()` 读超时检查
`void`	`close()` 选择器关闭方法
`int`	`dealException(SocketContext socketContext, Exception e)` 异常处理方法
`EventRunner`	`getEventRunner()`
`int`	`loadAndPrepare(IoSession session, int readSize)` 数据读取
`int`	`readFromChannel(SocketContext socketContext, SelectableChannel selectableChannel)` 通用封装的从通道读数据的方法
`boolean`	`register(SocketContext socketContext, int ops)` 注册一个 SocketContext 到选择器
`boolean`	`select()` 事件选择业务
`void`	`tcpAccept(TcpServerSocket socketContext, SocketChannel socketChannel)` Tcp 服务接受一个新的连接
`int`	`tcpReadFromChannel(TcpSocket socketContext, SocketChannel socketChannel)` TCP 从通道读数据的方法
`int`	`tcpWriteToChannel(TcpSocket socketContext, ByteBuffer buffer)` TCP 向通道写数据的方法
`UdpSocket`	`udpAccept(UdpServerSocket socketContext, DatagramChannel datagramChannel, SocketAddress address)` UDP 服务接受一个新的连接
`int`	`udpReadFromChannel(SocketContext<DatagramChannel,UdpSession> socketContext, DatagramChannel datagramChannel)` UDP 从通道读数据的方法
`int`	`udpWriteToChannel(UdpSocket socketContext, ByteBuffer buffer)` UDP 向通道写数据的方法
`void`	`unRegister(SelectionKey selectionKey)` 在选择器中取消一个 SocketContext 的注册
`int`	`writeToChannel(SocketContext socketContext, ByteBuffer buffer)` 通用封装的向通道写数据的方法

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

- Field Detail
  - selector
```
protected Selector selector
```
  - isCheckTimeout
```
protected boolean isCheckTimeout
```
  - selectedKeys
```
protected ArraySet<SelectionKey> selectedKeys
```
  - selecting
```
protected AtomicBoolean selecting
```
- Constructor Detail
  - SocketSelector
```
public SocketSelector(EventRunner eventRunner,
                      boolean isCheckTimeout)
               throws IOException
```
    构造方法
    
    Parameters:
    
    eventRunner - 事件执行器
    
    isCheckTimeout - 是否检查超时
    
    Throws:
    
    IOException - IO 异常
- Method Detail
  - getEventRunner
```
public EventRunner getEventRunner()
```
  - register
```
public boolean register(SocketContext socketContext,
                        int ops)
```
    注册一个 SocketContext 到选择器
    
    Parameters:
    
    socketContext - SocketContext 对象
    
    ops - 需要关注的操作
    
    Returns:
    
    true:成功, false:失败
  - unRegister
```
public void unRegister(SelectionKey selectionKey)
```
    在选择器中取消一个 SocketContext 的注册
    
    Parameters:
    
    selectionKey - SocketContext 对象
  - addIoEvent
```
public void addIoEvent()
```
    向执行器中增加一个选择事件
  - addEvent
```
public void addEvent(int priority,
                     Runnable runnable)
```
    向执行器中增加一个选择事件
    
    Parameters:
    
    priority - 指定的事件优先级, 越小优先级越高, 1-3 预留事件等级, 4:IO 事件, 5:EventProcess 事件, 6: Socket 注册/注销事件, 7-10 预留事件等级
    
    runnable - 在事件选择前执行的方法
  - select
```
public boolean select()
```
    事件选择业务
    
    Returns:
    
    true: 有相关的 NIO 事件被处理, false: 无相关 NIO 事件被处理
  - checkReadTimeout
```
public void checkReadTimeout()
```
    读超时检查
  - close
```
public void close()
```
    选择器关闭方法
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - readFromChannel
```
public int readFromChannel(SocketContext socketContext,
                           SelectableChannel selectableChannel)
```
    通用封装的从通道读数据的方法
    
    Parameters:
    
    socketContext - SocketContext 对象
    
    selectableChannel - 读取的 SelectableChannel 对象
    
    Returns:
    
    读取数据的字节数, -1:读取失败
  - writeToChannel
```
public int writeToChannel(SocketContext socketContext,
                          ByteBuffer buffer)
```
    通用封装的向通道写数据的方法
    
    Parameters:
    
    socketContext - SocketContext 对象
    
    buffer - 待写入的数据缓冲对象
    
    Returns:
    
    写入数据的字节数, -1:写入失败
  - tcpAccept
```
public void tcpAccept(TcpServerSocket socketContext,
                      SocketChannel socketChannel)
```
    Tcp 服务接受一个新的连接
    
    Parameters:
    
    socketContext - SocketContext 对象
    
    socketChannel - Socketchannel 对象
  - tcpReadFromChannel
```
public int tcpReadFromChannel(TcpSocket socketContext,
                              SocketChannel socketChannel)
                       throws IOException
```
    TCP 从通道读数据的方法
    
    Parameters:
    
    socketContext - TcpSocket 对象
    
    socketChannel - 读取的 Socketchannel 对象
    
    Returns:
    
    读取数据的字节数, -1:读取失败
    
    Throws:
    
    IOException - IO 异常
  - tcpWriteToChannel
```
public int tcpWriteToChannel(TcpSocket socketContext,
                             ByteBuffer buffer)
                      throws IOException
```
    TCP 向通道写数据的方法
    
    Parameters:
    
    socketContext - TcpSocket 对象
    
    buffer - 待写入的数据缓冲对象
    
    Returns:
    
    写入数据的字节数, -1:写入失败
    
    Throws:
    
    IOException - IO 异常
  - udpAccept
```
public UdpSocket udpAccept(UdpServerSocket socketContext,
                           DatagramChannel datagramChannel,
                           SocketAddress address)
                    throws IOException
```
    UDP 服务接受一个新的连接
    
    Parameters:
    
    socketContext - UdpServerSocket 对象
    
    datagramChannel - DatagramChannel 对象
    
    address - 接受通道的地址信息
    
    Returns:
    
    接受收到的 UdpSocket 对象
    
    Throws:
    
    IOException - IO异常
  - udpReadFromChannel
```
public int udpReadFromChannel(SocketContext<DatagramChannel,UdpSession> socketContext,
                              DatagramChannel datagramChannel)
                       throws IOException
```
    UDP 从通道读数据的方法
    
    Parameters:
    
    socketContext - SocketContext 对象
    
    datagramChannel - 读取的 DatagramChannel 对象
    
    Returns:
    
    读取数据的字节数, -1:读取失败
    
    Throws:
    
    IOException - IO 异
  - udpWriteToChannel
```
public int udpWriteToChannel(UdpSocket socketContext,
                             ByteBuffer buffer)
                      throws IOException
```
    UDP 向通道写数据的方法
    
    Parameters:
    
    socketContext - UdpSocket 对象
    
    buffer - 待写入的数据缓冲对象
    
    Returns:
    
    写入数据的字节数, -1:写入失败
    
    Throws:
    
    IOException - IO 异
  - loadAndPrepare
```
public int loadAndPrepare(IoSession session,
                          int readSize)
                   throws IOException
```
    数据读取
    
    Parameters:
    
    session - IoSession会话对象
    
    readSize - 需要读取数据大小
    
    Returns:
    
    实际读取的数据大小
    
    Throws:
    
    IOException - IO 异常
  - dealException
```
public int dealException(SocketContext socketContext,
                         Exception e)
```
    异常处理方法
    
    Parameters:
    
    socketContext - SocketContext 对象
    
    e - Exception 异常对象
    
    Returns:
    
    永远返回 -1

Class SocketSelector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

selector

isCheckTimeout

selectedKeys

selecting

Constructor Detail

SocketSelector

Method Detail

getEventRunner

register

unRegister

addIoEvent

addEvent

select

checkReadTimeout

close

readFromChannel

writeToChannel

tcpAccept

tcpReadFromChannel

tcpWriteToChannel

udpAccept

udpReadFromChannel

udpWriteToChannel

loadAndPrepare

dealException