SocketContext (Voovan-network 3.0.0 API)

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

直接已知子类:

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

作者:

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

字段概要

字段
限定符和类型	字段和说明
`protected int`	`bufferSize`
`protected ConnectModel`	`connectModel`
`protected Chain<IoFilter>`	`filterChain`
`protected IoHandler`	`handler`
`protected String`	`host`
`protected int`	`idleInterval`
`protected MessageSplitter`	`messageSplitter`
`protected int`	`port`
`protected int`	`readTimeout`
`protected SSLManager`	`sslManager`

构造器概要

构造器
限定符	构造器和说明
`protected`	`SocketContext()` 无参数构造函数
	`SocketContext(String host, int port, int readTimeout)` 构造函数默认不会出发空闲事件
	`SocketContext(String host, int port, int readTimeout, int idleInterval)` 构造函数

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected abstract void`	`acceptStart()` 用于针对 Accept 进来的 Socket 连接的启动
`abstract boolean`	`close()` 关闭连接
`protected void`	`copyFrom(SocketContext parentSocketContext)` 克隆对象
`Chain<IoFilter>`	`filterChain()` 获取过滤器链
`int`	`getBufferSize()` 获取缓冲区大小
`ConnectModel`	`getConnectModel()` 获取连接模式
`String`	`getHost()` 获取主机地址
`int`	`getIdleInterval()` 获取空闲事件时间
`int`	`getPort()` 获取主机端口
`int`	`getReadTimeout()` 获取超时时间
`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)` 设置消息粘包分割器
`void`	`setBufferSize(int bufferSize)` 设置缓冲区大小
`abstract void`	`setIdleInterval(int idleInterval)` 设置空闲事件时间
`abstract <T> void`	`setOption(SocketOption<T> name, T value)` 设置 Socket 的 Option 选项
`void`	`setSSLManager(SSLManager sslManager)` 设置 SSL 管理器
`abstract void`	`start()` 启动上下文连接阻塞方法
`abstract void`	`syncStart()` 启动同步的上下文连接非阻塞方法
`protected void`	`waitConnected(IoSession session)` 等待连接完成

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - host
```
protected String host
```
  - port
```
protected int port
```
  - readTimeout
```
protected int readTimeout
```
  - handler
```
protected IoHandler handler
```
  - filterChain
```
protected Chain<IoFilter> filterChain
```
  - messageSplitter
```
protected MessageSplitter messageSplitter
```
  - sslManager
```
protected SSLManager sslManager
```
  - connectModel
```
protected ConnectModel connectModel
```
  - bufferSize
```
protected int bufferSize
```
  - idleInterval
```
protected int idleInterval
```
- 构造器详细资料
  - SocketContext
```
public SocketContext(String host,
                     int port,
                     int readTimeout)
```
    构造函数默认不会出发空闲事件
    
    参数:
    
    host - 主机地址
    
    port - 主机端口
    
    readTimeout - 超时时间
  - SocketContext
```
public SocketContext(String host,
                     int port,
                     int readTimeout,
                     int idleInterval)
```
    构造函数
    
    参数:
    
    host - 主机地址
    
    port - 主机端口
    
    idleInterval - 空闲事件触发时间, 单位: 秒
    
    readTimeout - 超时时间
  - SocketContext
```
protected SocketContext()
```
    无参数构造函数
- 方法详细资料
  - initSSL
```
protected void initSSL(IoSession session)
                throws SSLException
```
    抛出:
    
    SSLException
  - copyFrom
```
protected void copyFrom(SocketContext parentSocketContext)
```
    克隆对象
    
    参数:
    
    parentSocketContext - 父 socket 对象
  - getIdleInterval
```
public int getIdleInterval()
```
    获取空闲事件时间
    
    返回:
    
    空闲事件时间, 单位:秒
  - setIdleInterval
```
public abstract void setIdleInterval(int idleInterval)
```
    设置空闲事件时间
    
    参数:
    
    idleInterval - 空闲事件时间, 单位:秒
  - setOption
```
public abstract <T> void setOption(SocketOption<T> name,
                                   T value)
                            throws IOException
```
    设置 Socket 的 Option 选项
    
    类型参数:
    
    T - 范型
    
    参数:
    
    name - SocketOption类型的枚举, 参照:AsynchronousSocketChannel.setOption的说明
    
    value - SocketOption参数
    
    抛出:
    
    IOException - IO异常
  - getBufferSize
```
public int getBufferSize()
```
    获取缓冲区大小
    
    返回:
    
    缓冲区大小 (default:1024)
  - setBufferSize
```
public void setBufferSize(int bufferSize)
```
    设置缓冲区大小
    
    参数:
    
    bufferSize - 缓冲区大小 (default:1024)
  - getSSLManager
```
public SSLManager getSSLManager()
```
    获取 SSL 管理器
    
    返回:
    
    SSL 管理器
  - setSSLManager
```
public void setSSLManager(SSLManager sslManager)
```
    设置 SSL 管理器
    
    参数:
    
    sslManager - SSL 管理器
  - getHost
```
public String getHost()
```
    获取主机地址
    
    返回:
    
    主机地址
  - getPort
```
public int getPort()
```
    获取主机端口
    
    返回:
    
    主机端口
  - getReadTimeout
```
public int getReadTimeout()
```
    获取超时时间
    
    返回:
    
    超时时间
  - getConnectModel
```
public ConnectModel getConnectModel()
```
    获取连接模式
    
    返回:
    
    连接模式
  - handler
```
public IoHandler handler()
```
    获取业务处理句柄
    
    返回:
    
    业务处理句柄
  - handler
```
public void handler(IoHandler handler)
```
    设置业务处理句柄
    
    参数:
    
    handler - 业务处理句柄
  - filterChain
```
public Chain<IoFilter> filterChain()
```
    获取过滤器链
    
    返回:
    
    过滤器链
  - messageSplitter
```
public MessageSplitter messageSplitter()
```
    获取消息粘包分割器
    
    返回:
    
    消息粘包分割器
  - messageSplitter
```
public void messageSplitter(MessageSplitter messageSplitter)
```
    设置消息粘包分割器
    
    参数:
    
    messageSplitter - 消息分割器
  - start
```
public abstract void start()
                    throws IOException
```
    启动上下文连接阻塞方法
    
    抛出:
    
    IOException - IO 异常
  - syncStart
```
public abstract void syncStart()
                        throws IOException
```
    启动同步的上下文连接非阻塞方法
    
    抛出:
    
    IOException - IO异常
  - acceptStart
```
protected abstract void acceptStart()
                             throws IOException
```
    用于针对 Accept 进来的 Socket 连接的启动
    
    抛出:
    
    IOException - IO异常
  - waitConnected
```
protected void waitConnected(IoSession session)
```
    等待连接完成
    
    参数:
    
    session - socket 会话对象
  - isOpen
```
public abstract boolean isOpen()
```
    上下文连接是否打开
    
    返回:
    
    true:连接打开,false:连接关闭
  - isConnected
```
public abstract boolean isConnected()
```
    上下文连接是否连接
    
    返回:
    
    true:连接,false:断开
  - close
```
public abstract boolean close()
```
    关闭连接
    
    返回:
    
    是否关闭

类 SocketContext

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

host

port

readTimeout

handler

filterChain

messageSplitter

sslManager

connectModel

bufferSize

idleInterval

构造器详细资料

SocketContext

SocketContext

SocketContext

方法详细资料

initSSL

copyFrom

getIdleInterval

setIdleInterval

setOption

getBufferSize

setBufferSize

getSSLManager

setSSLManager

getHost

getPort

getReadTimeout

getConnectModel

handler

handler

filterChain

messageSplitter

messageSplitter

start

syncStart

acceptStart

waitConnected

isOpen

isConnected

close