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

java.lang.Object
- org.voovan.tools.pool.PooledObject
- - org.voovan.network.SocketContext<C,S>

All Implemented Interfaces:

IPooledObject

Direct Known Subclasses:

TcpServerSocket, TcpSocket, UdpServerSocket, UdpSocket
```
public abstract class SocketContext<C extends SelectableChannel,S extends IoSession>
extends PooledObject
```
socket 上下文

Author:

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCEPT_THREAD_SIZE`
`static boolean`	`ASYNC_RECIVE`
`static boolean`	`ASYNC_SEND`
`static Boolean`	`CHECK_TIMEOUT`
`static EventRunnerGroup`	`COMMON_ACCEPT_EVENT_RUNNER_GROUP`
`static EventRunnerGroup`	`COMMON_IO_EVENT_RUNNER_GROUP`
`protected ConnectModel`	`connectModel`
`protected ConnectType`	`connectType`
`protected Chain<IoFilter>`	`filterChain`
`protected IoHandler`	`handler`
`protected String`	`host`
`protected int`	`idleInterval`
`static int`	`IO_THREAD_SIZE`
`protected boolean`	`isSynchronous`
`protected long`	`lastReadTime`
`protected MessageSplitter`	`messageSplitter`
`protected int`	`port`
`protected int`	`readBufferSize`
`protected int`	`readTimeout`
`protected Chain<IoFilter>`	`reciveFilterChain`
`static int`	`SELECT_INTERVAL`
`protected int`	`sendBufferSize`
`protected Chain<IoFilter>`	`sendFilterChain`
`protected int`	`sendTimeout`
`protected SSLManager`	`sslManager`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SocketContext()` 无参数构造函数
	`SocketContext(String host, int port, int readTimeout)` 构造函数默认不会出发空闲事件, 默认发超时时间: 1s
	`SocketContext(String host, int port, int readTimeout, int idleInterval)` 构造函数默认发超时时间: 1s
	`SocketContext(String host, int port, int readTimeout, int sendTimeout, int idleInterval)` 构造函数

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`acceptStart()` 用于针对 Accept 进来的 Socket 连接的启动
`void`	`bindToSocketSelector(int ops)` 绑定到 SocketSelector
`abstract boolean`	`close()` 关闭连接
`protected void`	`copyFrom(SocketContext parentSocketContext)` 克隆对象
`static EventRunnerGroup`	`createEventRunnerGroup(String name, int size, boolean isAccept)` 构造事件管理器
`Chain<IoFilter>`	`filterChain()` 获取过滤器链
`EventRunnerGroup`	`getAcceptEventRunnerGroup()`
`static EventRunnerGroup`	`getCommonAcceptEventRunnerGroup()` 获取公共的 Accept 事件执行器
`static EventRunnerGroup`	`getCommonIoEventRunnerGroup()` 获取公共的 IO 事件执行器
`ConnectModel`	`getConnectModel()` 获取连接模式
`ConnectType`	`getConnectType()` 获取连接类型
`String`	`getHost()` 获取主机地址
`int`	`getIdleInterval()` 获取空闲事件时间
`EventRunnerGroup`	`getIoEventRunnerGroup()`
`long`	`getLastReadTime()`
`int`	`getPort()` 获取主机端口
`int`	`getReadBufferSize()` 会话读缓冲区大小
`int`	`getReadTimeout()` 获取超时时间
`protected Chain<IoFilter>`	`getReciveFilterChain()`
`int`	`getSendBufferSize()` 会话写缓冲区大小
`protected Chain<IoFilter>`	`getSendFilterChain()`
`int`	`getSendTimeout()`
`abstract S`	`getSession()`
`SSLManager`	`getSSLManager()` 获取 SSL 管理器
`static void`	`gracefulShutdown()` 平滑的关闭 Socket 线程池
`IoHandler`	`handler()` 获取业务处理句柄
`void`	`handler(IoHandler handler)` 设置业务处理句柄
`protected void`	`initSSL(IoSession session)`
`abstract boolean`	`isConnected()` 上下文连接是否连接
`abstract boolean`	`isOpen()` 上下文连接是否打开
`boolean`	`isRegister()`
`boolean`	`isTimeOut()`
`MessageSplitter`	`messageSplitter()` 获取消息粘包分割器
`void`	`messageSplitter(MessageSplitter messageSplitter)` 设置消息粘包分割器
`void`	`setAcceptEventRunnerGroup(EventRunnerGroup acceptEventRunnerGroup)`
`abstract void`	`setIdleInterval(int idleInterval)` 设置空闲事件时间
`void`	`setIoEventRunnerGroup(EventRunnerGroup ioEventRunnerGroup)`
`abstract <T> void`	`setOption(SocketOption<T> name, T value)` 设置 Socket 的 Option 选项
`void`	`setReadBufferSize(int readBufferSize)` 设置会话读缓冲区大小
`protected void`	`setRegister(boolean register)`
`void`	`setSendBufferSize(int sendBufferSize)` 设置会话写缓冲区大小
`void`	`setSSLManager(SSLManager sslManager)` 设置 SSL 管理器
`abstract C`	`socketChannel()` 获取 SocketChannel 对象
`abstract void`	`start()` 启动上下文连接阻塞方法
`abstract void`	`syncStart()` 启动同步的上下文连接非阻塞方法
`void`	`updateLastTime()`
`void`	`waitConnect()` 等待连接完成, 包含事件注册和 SSL 握手, 用于在同步调用的方法中同步

Methods inherited from class org.voovan.tools.pool.PooledObject
getPoolObjectId, setPoolObjectId

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

- Field Detail
  - ACCEPT_THREAD_SIZE
```
public static int ACCEPT_THREAD_SIZE
```
  - IO_THREAD_SIZE
```
public static int IO_THREAD_SIZE
```
  - SELECT_INTERVAL
```
public static final int SELECT_INTERVAL
```
  - CHECK_TIMEOUT
```
public static final Boolean CHECK_TIMEOUT
```
  - ASYNC_SEND
```
public static final boolean ASYNC_SEND
```
  - ASYNC_RECIVE
```
public static final boolean ASYNC_RECIVE
```
  - COMMON_ACCEPT_EVENT_RUNNER_GROUP
```
public static EventRunnerGroup COMMON_ACCEPT_EVENT_RUNNER_GROUP
```
  - COMMON_IO_EVENT_RUNNER_GROUP
```
public static EventRunnerGroup COMMON_IO_EVENT_RUNNER_GROUP
```
  - host
```
protected String host
```
  - port
```
protected int port
```
  - readTimeout
```
protected int readTimeout
```
  - sendTimeout
```
protected int sendTimeout
```
  - handler
```
protected IoHandler handler
```
  - filterChain
```
protected Chain<IoFilter> filterChain
```
  - reciveFilterChain
```
protected Chain<IoFilter> reciveFilterChain
```
  - sendFilterChain
```
protected Chain<IoFilter> sendFilterChain
```
  - messageSplitter
```
protected MessageSplitter messageSplitter
```
  - sslManager
```
protected SSLManager sslManager
```
  - connectModel
```
protected ConnectModel connectModel
```
  - connectType
```
protected ConnectType connectType
```
  - readBufferSize
```
protected int readBufferSize
```
  - sendBufferSize
```
protected int sendBufferSize
```
  - idleInterval
```
protected int idleInterval
```
  - lastReadTime
```
protected long lastReadTime
```
  - isSynchronous
```
protected boolean isSynchronous
```
- Constructor Detail
  - SocketContext
```
public SocketContext(String host,
                     int port,
                     int readTimeout)
```
    构造函数默认不会出发空闲事件, 默认发超时时间: 1s
    
    Parameters:
    
    host - 主机地址
    
    port - 主机端口
    
    readTimeout - 超时时间
  - SocketContext
```
public SocketContext(String host,
                     int port,
                     int readTimeout,
                     int idleInterval)
```
    构造函数默认发超时时间: 1s
    
    Parameters:
    
    host - 主机地址
    
    port - 主机端口
    
    readTimeout - 读超时时间, 单位: 毫秒
    
    idleInterval - 空闲事件触发时间
  - SocketContext
```
public SocketContext(String host,
                     int port,
                     int readTimeout,
                     int sendTimeout,
                     int idleInterval)
```
    构造函数
    
    Parameters:
    
    host - 主机地址
    
    port - 主机端口
    
    readTimeout - 读超时时间, 单位: 毫秒
    
    sendTimeout - 发超时时间, 单位: 毫秒
    
    idleInterval - 空闲事件触发时间
  - SocketContext
```
protected SocketContext()
```
    无参数构造函数
- Method Detail
  - createEventRunnerGroup
```
public static EventRunnerGroup createEventRunnerGroup(String name,
                                                      int size,
                                                      boolean isAccept)
```
    构造事件管理器
    
    Parameters:
    
    name - 事件执行器名称
    
    size - 容纳事件执行器的数量
    
    isAccept - 是否处理 Accept 事件
    
    Returns:
    
    事件执行器
  - getCommonAcceptEventRunnerGroup
```
public static EventRunnerGroup getCommonAcceptEventRunnerGroup()
```
    获取公共的 Accept 事件执行器
    
    Returns:
    
    Accept 事件执行器
  - getCommonIoEventRunnerGroup
```
public static EventRunnerGroup getCommonIoEventRunnerGroup()
```
    获取公共的 IO 事件执行器
    
    Returns:
    
    IO 事件执行器
  - getAcceptEventRunnerGroup
```
public EventRunnerGroup getAcceptEventRunnerGroup()
```
  - setAcceptEventRunnerGroup
```
public void setAcceptEventRunnerGroup(EventRunnerGroup acceptEventRunnerGroup)
```
  - getIoEventRunnerGroup
```
public EventRunnerGroup getIoEventRunnerGroup()
```
  - setIoEventRunnerGroup
```
public void setIoEventRunnerGroup(EventRunnerGroup ioEventRunnerGroup)
```
  - initSSL
```
protected void initSSL(IoSession session)
                throws SSLException
```
    Throws:
    
    SSLException
  - copyFrom
```
protected void copyFrom(SocketContext parentSocketContext)
```
    克隆对象
    
    Parameters:
    
    parentSocketContext - 父 socket 对象
  - getIdleInterval
```
public int getIdleInterval()
```
    获取空闲事件时间
    
    Returns:
    
    空闲事件时间, 单位:秒
  - setIdleInterval
```
public abstract void setIdleInterval(int idleInterval)
```
    设置空闲事件时间
    
    Parameters:
    
    idleInterval - 空闲事件时间, 单位:秒
  - setOption
```
public abstract <T> void setOption(SocketOption<T> name,
                                   T value)
                            throws IOException
```
    设置 Socket 的 Option 选项
    
    Type Parameters:
    
    T - 范型
    
    Parameters:
    
    name - SocketOption类型的枚举, 参照:AsynchronousSocketChannel.setOption的说明
    
    value - SocketOption参数
    
    Throws:
    
    IOException - IO异常
  - socketChannel
```
public abstract C socketChannel()
```
    获取 SocketChannel 对象
    
    Returns:
    
    SocketChannel 对象
  - getLastReadTime
```
public long getLastReadTime()
```
  - updateLastTime
```
public void updateLastTime()
```
  - isTimeOut
```
public boolean isTimeOut()
```
  - getReadBufferSize
```
public int getReadBufferSize()
```
    会话读缓冲区大小
    
    Returns:
    
    读缓冲区大小
  - setReadBufferSize
```
public void setReadBufferSize(int readBufferSize)
```
    设置会话读缓冲区大小
    
    Parameters:
    
    readBufferSize - 读缓冲区大小
  - getSendBufferSize
```
public int getSendBufferSize()
```
    会话写缓冲区大小
    
    Returns:
    
    读缓冲区大小
  - setSendBufferSize
```
public void setSendBufferSize(int sendBufferSize)
```
    设置会话写缓冲区大小
    
    Parameters:
    
    sendBufferSize - 读缓冲区大小
  - isRegister
```
public boolean isRegister()
```
  - setRegister
```
protected void setRegister(boolean register)
```
  - getSSLManager
```
public SSLManager getSSLManager()
```
    获取 SSL 管理器
    
    Returns:
    
    SSL 管理器
  - setSSLManager
```
public void setSSLManager(SSLManager sslManager)
```
    设置 SSL 管理器
    
    Parameters:
    
    sslManager - SSL 管理器
  - getHost
```
public String getHost()
```
    获取主机地址
    
    Returns:
    
    主机地址
  - getPort
```
public int getPort()
```
    获取主机端口
    
    Returns:
    
    主机端口
  - getReadTimeout
```
public int getReadTimeout()
```
    获取超时时间
    
    Returns:
    
    超时时间
  - getSendTimeout
```
public int getSendTimeout()
```
  - getConnectModel
```
public ConnectModel getConnectModel()
```
    获取连接模式
    
    Returns:
    
    连接模式 ConnectModel.CLIENT,ConnectModel.LISTENER, ConnectModel.SERVER
  - getConnectType
```
public ConnectType getConnectType()
```
    获取连接类型
    
    Returns:
    
    连接类型 ConnectType.TCP / ConnectType.UDP
  - handler
```
public IoHandler handler()
```
    获取业务处理句柄
    
    Returns:
    
    业务处理句柄
  - handler
```
public void handler(IoHandler handler)
```
    设置业务处理句柄
    
    Parameters:
    
    handler - 业务处理句柄
  - filterChain
```
public Chain<IoFilter> filterChain()
```
    获取过滤器链
    
    Returns:
    
    过滤器链
  - getReciveFilterChain
```
protected Chain<IoFilter> getReciveFilterChain()
```
  - getSendFilterChain
```
protected Chain<IoFilter> getSendFilterChain()
```
  - messageSplitter
```
public MessageSplitter messageSplitter()
```
    获取消息粘包分割器
    
    Returns:
    
    消息粘包分割器
  - messageSplitter
```
public void messageSplitter(MessageSplitter messageSplitter)
```
    设置消息粘包分割器
    
    Parameters:
    
    messageSplitter - 消息分割器
  - getSession
```
public abstract S getSession()
```
  - start
```
public abstract void start()
                    throws IOException
```
    启动上下文连接阻塞方法
    
    Throws:
    
    IOException - IO 异常
  - syncStart
```
public abstract void syncStart()
                        throws IOException
```
    启动同步的上下文连接非阻塞方法
    
    Throws:
    
    IOException - IO异常
  - acceptStart
```
protected abstract void acceptStart()
                             throws IOException
```
    用于针对 Accept 进来的 Socket 连接的启动
    
    Throws:
    
    IOException - IO异常
  - isOpen
```
public abstract boolean isOpen()
```
    上下文连接是否打开
    
    Returns:
    
    true:连接打开,false:连接关闭
  - isConnected
```
public abstract boolean isConnected()
```
    上下文连接是否连接
    
    Returns:
    
    true:连接,false:断开
  - close
```
public abstract boolean close()
```
    关闭连接
    
    Returns:
    
    是否关闭
  - waitConnect
```
public void waitConnect()
```
    等待连接完成, 包含事件注册和 SSL 握手, 用于在同步调用的方法中同步
  - bindToSocketSelector
```
public void bindToSocketSelector(int ops)
```
    绑定到 SocketSelector
    
    Parameters:
    
    ops - 选择的操作类型
  - gracefulShutdown
```
public static void gracefulShutdown()
```
    平滑的关闭 Socket 线程池

Class SocketContext<C extends SelectableChannel,S extends IoSession>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.voovan.tools.pool.PooledObject

Methods inherited from class java.lang.Object

Field Detail

ACCEPT_THREAD_SIZE

IO_THREAD_SIZE

SELECT_INTERVAL

CHECK_TIMEOUT

ASYNC_SEND

ASYNC_RECIVE

COMMON_ACCEPT_EVENT_RUNNER_GROUP

COMMON_IO_EVENT_RUNNER_GROUP

host

port

readTimeout

sendTimeout

handler

filterChain

reciveFilterChain

sendFilterChain

messageSplitter

sslManager

connectModel

connectType

readBufferSize

sendBufferSize

idleInterval

lastReadTime

isSynchronous

Constructor Detail

SocketContext

SocketContext

SocketContext

SocketContext

Method Detail

createEventRunnerGroup

getCommonAcceptEventRunnerGroup

getCommonIoEventRunnerGroup

getAcceptEventRunnerGroup

setAcceptEventRunnerGroup

getIoEventRunnerGroup

setIoEventRunnerGroup

initSSL

copyFrom

getIdleInterval

setIdleInterval

setOption

socketChannel

getLastReadTime

updateLastTime

isTimeOut

getReadBufferSize

setReadBufferSize

getSendBufferSize

setSendBufferSize

isRegister

setRegister

getSSLManager

setSSLManager

getHost

getPort

getReadTimeout

getSendTimeout

getConnectModel

getConnectType

handler

handler

filterChain

getReciveFilterChain

getSendFilterChain

messageSplitter

messageSplitter

getSession

start

syncStart

acceptStart

isOpen