org.voovan.network.aio

Class AioSocket

java.lang.Object

org.voovan.network.SocketContext

org.voovan.network.aio.AioSocket

public class AioSocket
extends SocketContext

AioSocket 连接

Author:

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

Field Summary

Fields inherited from class org.voovan.network.SocketContext

ASYNCHRONOUS_CHANNEL_GROUP, connectModel, filterChain, handler, host, idleInterval, messageSplitter, port, readBufferSize, readRecursionDepth, readTimeout, sendBufferSize, sendTimeout, sslManager

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	acceptStart() 用于针对 Accept 进来的 Socket 连接的启动
protected void	catchConnected() 捕获 Aio Connect
protected void	catchRead() 捕获 Aio Read
boolean	close() 关闭连接
AioSession	getSession() 获取 Session 对象
boolean	isConnected() 上下文连接是否连接
boolean	isOpen() 上下文连接是否打开
AioSocket	restart() 重连当前连接
void	setIdleInterval(int idleInterval) 设置空闲事件时间
<T> void	setOption(SocketOption<T> name, T value) 设置 Socket 的 Option 选项
AsynchronousSocketChannel	socketChannel() 获取 SocketChannel 对象
void	start() 启动上下文连接 阻塞方法
Object	synchronouRead() 同步读取消息
void	synchronouSend(Object obj) 同步发送消息
AioSocket	syncRestart() 重连当前连接 同步模式
void	syncStart() 启动同步的上下文连接 非阻塞方法

Methods inherited from class org.voovan.network.SocketContext

buildAsynchronousChannelGroup, copyFrom, filterChain, getConnectModel, getHost, getIdleInterval, getPort, getReadBufferSize, getReadRecursionDepth, getReadTimeout, getSendBufferSize, getSendTimeout, getSSLManager, handler, handler, initSSL, messageSplitter, messageSplitter, setReadBufferSize, setReadRecursionDepth, setSendBufferSize, setSSLManager, waitConnected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AioSocket

public AioSocket(String host,
                 int port,
                 int readTimeout)
          throws IOException

构造函数 默认不会出发空闲事件, 默认发超时时间: 1s

Parameters:

host - 主机地址

port - 主机端口

readTimeout - 主机超时时间, 单位:毫秒

Throws:

IOException - IO 异常

AioSocket

public AioSocket(String host,
                 int port,
                 int readTimeout,
                 int idleInterval)
          throws IOException

构造函数 默认发超时时间: 1s

Parameters:

host - 主机地址

port - 主机端口

idleInterval - 空闲事件触发时间, 单位: 秒

readTimeout - 主机超时时间, 单位:毫秒

Throws:

IOException - IO 异常

AioSocket

public AioSocket(String host,
                 int port,
                 int readTimeout,
                 int sendTimeout,
                 int idleInterval)
          throws IOException

构造函数

Parameters:

host - 主机地址

port - 主机端口

idleInterval - 空闲事件触发时间, 单位: 秒

readTimeout - 主机超时时间, 单位:毫秒

sendTimeout - 发超时时间, 单位: 毫秒

Throws:

IOException - IO 异常

AioSocket

protected AioSocket(SocketContext parentSocketContext,
                    AsynchronousSocketChannel socketChannel)
             throws IOException

构造函数

Parameters:

parentSocketContext - 父异步 socket 通道

socketChannel - 异步 socket 通道

Throws:

IOException - IO 异常

Method Detail

setIdleInterval

public void setIdleInterval(int idleInterval)

Description copied from class: SocketContext

设置空闲事件时间

Specified by:

setIdleInterval in class SocketContext

Parameters:

idleInterval - 空闲事件时间, 单位:秒

setOption

public <T> void setOption(SocketOption<T> name,
                          T value)
                   throws IOException

设置 Socket 的 Option 选项

Specified by:

setOption in class SocketContext

Type Parameters:

T - 范型

Parameters:

name - SocketOption类型的枚举, 参照:AsynchronousSocketChannel.setOption的说明

value - SocketOption参数

Throws:

IOException - IO异常

catchConnected

protected void catchConnected()
                       throws Exception

捕获 Aio Connect

Throws:

Exception - 异常

catchRead

protected void catchRead()

捕获 Aio Read

getSession

public AioSession getSession()

获取 Session 对象

Returns:

Session 对象

start

public void start()
           throws IOException

启动上下文连接 阻塞方法

Specified by:

start in class SocketContext

Throws:

IOException - IO 异常

syncStart

public void syncStart()
               throws IOException

启动同步的上下文连接 非阻塞方法

Specified by:

syncStart in class SocketContext

Throws:

IOException - IO异常

acceptStart

protected void acceptStart()
                    throws IOException

Description copied from class: SocketContext

用于针对 Accept 进来的 Socket 连接的启动

Specified by:

acceptStart in class SocketContext

Throws:

IOException - IO异常

restart

public AioSocket restart()
                  throws IOException,
                         RestartException

重连当前连接

Returns:

AioSocket对象

Throws:

IOException - IO 异常

RestartException - 重新启动的异常

syncRestart

public AioSocket syncRestart()
                      throws IOException,
                             RestartException

重连当前连接 同步模式

Returns:

AioSocket对象

Throws:

IOException - IO 异常

RestartException - 重新启动的异常

socketChannel

public AsynchronousSocketChannel socketChannel()

获取 SocketChannel 对象

Returns:

异步 Socket 通道

isOpen

public boolean isOpen()

Description copied from class: SocketContext

上下文连接是否打开

Specified by:

isOpen in class SocketContext

Returns:

true:连接打开,false:连接关闭

isConnected

public boolean isConnected()

Description copied from class: SocketContext

上下文连接是否连接

Specified by:

isConnected in class SocketContext

Returns:

true:连接,false:断开

synchronouRead

public Object synchronouRead()
                      throws ReadMessageException

同步读取消息

Returns:

读取出的对象

Throws:

ReadMessageException - 读取消息异常

synchronouSend

public void synchronouSend(Object obj)
                    throws SendMessageException

同步发送消息

Parameters:

obj - 要发送的对象

Throws:

SendMessageException - 消息发送异常

close

public boolean close()

Description copied from class: SocketContext

关闭连接

Specified by:

close in class SocketContext

Returns:

是否关闭