SocketContext (Voovan-network 4.0.6.3 API)

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

Direct Known Subclasses:

AioServerSocket, AioSocket, NioServerSocket, NioSocket, UdpServerSocket, UdpSocket
```
public abstract class SocketContext
extends Object
```
socket 上下文

Author:

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected static AsynchronousChannelGroup`	`ASYNCHRONOUS_CHANNEL_GROUP`
`protected ConnectModel`	`connectModel`
`protected Chain<IoFilter>`	`filterChain`
`protected IoHandler`	`handler`
`protected String`	`host`
`protected int`	`idleInterval`
`protected MessageSplitter`	`messageSplitter`
`protected int`	`port`
`protected int`	`readBufferSize`
`protected int`	`readRecursionDepth`
`protected int`	`readTimeout`
`protected int`	`sendBufferSize`
`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 连接的启动
`static AsynchronousChannelGroup`	`buildAsynchronousChannelGroup()` 构造一个异步通道线程组
`abstract boolean`	`close()` 关闭连接
`protected void`	`copyFrom(SocketContext parentSocketContext)` 克隆对象
`Chain<IoFilter>`	`filterChain()` 获取过滤器链
`ConnectModel`	`getConnectModel()` 获取连接模式
`String`	`getHost()` 获取主机地址
`int`	`getIdleInterval()` 获取空闲事件时间
`int`	`getPort()` 获取主机端口
`int`	`getReadBufferSize()`
`int`	`getReadRecursionDepth()` 获取读递归深度控制
`int`	`getReadTimeout()` 获取超时时间
`int`	`getSendBufferSize()`
`int`	`getSendTimeout()`
`SSLManager`	`getSSLManager()` 获取 SSL 管理器
`IoHandler`	`handler()` 获取业务处理句柄
`void`	`handler(IoHandler handler)` 设置业务处理句柄
`protected void`	`initSSL(IoSession session)`
`abstract boolean`	`isConnected()` 上下文连接是否连接
`abstract boolean`	`isOpen()` 上下文连接是否打开
`MessageSplitter`	`messageSplitter()` 获取消息粘包分割器
`void`	`messageSplitter(MessageSplitter messageSplitter)` 设置消息粘包分割器
`abstract void`	`setIdleInterval(int idleInterval)` 设置空闲事件时间
`abstract <T> void`	`setOption(SocketOption<T> name, T value)` 设置 Socket 的 Option 选项
`void`	`setReadBufferSize(int readBufferSize)`
`void`	`setReadRecursionDepth(int readRecursionDepth)` 设置读递归深度控制
`void`	`setSendBufferSize(int sendBufferSize)`
`void`	`setSSLManager(SSLManager sslManager)` 设置 SSL 管理器
`abstract void`	`start()` 启动上下文连接阻塞方法
`abstract void`	`syncStart()` 启动同步的上下文连接非阻塞方法
`protected void`	`waitConnected(IoSession session)` 等待连接完成

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

- Field Detail
  - ASYNCHRONOUS_CHANNEL_GROUP
```
protected static AsynchronousChannelGroup ASYNCHRONOUS_CHANNEL_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
```
  - messageSplitter
```
protected MessageSplitter messageSplitter
```
  - sslManager
```
protected SSLManager sslManager
```
  - connectModel
```
protected ConnectModel connectModel
```
  - readBufferSize
```
protected int readBufferSize
```
  - sendBufferSize
```
protected int sendBufferSize
```
  - idleInterval
```
protected int idleInterval
```
  - readRecursionDepth
```
protected int readRecursionDepth
```
- 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
  - buildAsynchronousChannelGroup
```
public static AsynchronousChannelGroup buildAsynchronousChannelGroup()
```
    构造一个异步通道线程组
    
    Returns:
    
    AsynchronousChannelGroup 异步通道线程组
  - 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异常
  - getReadBufferSize
```
public int getReadBufferSize()
```
  - setReadBufferSize
```
public void setReadBufferSize(int readBufferSize)
```
  - getSendBufferSize
```
public int getSendBufferSize()
```
  - setSendBufferSize
```
public void setSendBufferSize(int sendBufferSize)
```
  - getReadRecursionDepth
```
public int getReadRecursionDepth()
```
    获取读递归深度控制
    
    Returns:
    
    读递归深度
  - setReadRecursionDepth
```
public void setReadRecursionDepth(int readRecursionDepth)
```
    设置读递归深度控制
    
    Parameters:
    
    readRecursionDepth - 读递归深度
  - 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:
    
    连接模式
  - handler
```
public IoHandler handler()
```
    获取业务处理句柄
    
    Returns:
    
    业务处理句柄
  - handler
```
public void handler(IoHandler handler)
```
    设置业务处理句柄
    
    Parameters:
    
    handler - 业务处理句柄
  - filterChain
```
public Chain<IoFilter> filterChain()
```
    获取过滤器链
    
    Returns:
    
    过滤器链
  - messageSplitter
```
public MessageSplitter messageSplitter()
```
    获取消息粘包分割器
    
    Returns:
    
    消息粘包分割器
  - messageSplitter
```
public void messageSplitter(MessageSplitter messageSplitter)
```
    设置消息粘包分割器
    
    Parameters:
    
    messageSplitter - 消息分割器
  - 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异常
  - waitConnected
```
protected void waitConnected(IoSession session)
```
    等待连接完成
    
    Parameters:
    
    session - socket 会话对象
  - isOpen
```
public abstract boolean isOpen()
```
    上下文连接是否打开
    
    Returns:
    
    true:连接打开,false:连接关闭
  - isConnected
```
public abstract boolean isConnected()
```
    上下文连接是否连接
    
    Returns:
    
    true:连接,false:断开
  - close
```
public abstract boolean close()
```
    关闭连接
    
    Returns:
    
    是否关闭

Class SocketContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ASYNCHRONOUS_CHANNEL_GROUP

host

port

readTimeout

sendTimeout

handler

filterChain

messageSplitter

sslManager

connectModel

readBufferSize

sendBufferSize

idleInterval

readRecursionDepth

Constructor Detail

SocketContext

SocketContext

SocketContext

SocketContext

Method Detail

buildAsynchronousChannelGroup

initSSL

copyFrom

getIdleInterval

setIdleInterval

setOption

getReadBufferSize

setReadBufferSize

getSendBufferSize

setSendBufferSize

getReadRecursionDepth

setReadRecursionDepth

getSSLManager

setSSLManager

getHost

getPort

getReadTimeout

getSendTimeout

getConnectModel

handler

handler

filterChain

messageSplitter

messageSplitter

start

syncStart

acceptStart

waitConnected

isOpen

isConnected

close