org.voovan.network.aio

类 AioSocket

java.lang.Object

org.voovan.network.SocketContext

org.voovan.network.aio.AioSocket

public class AioSocket
extends SocketContext

AioSocket 连接

作者:

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

字段概要

从类继承的字段 org.voovan.network.SocketContext

bufferSize, connectModel, filterChain, handler, host, idleInterval, messageSplitter, port, readTimeout, sslManager

构造器概要

构造器

限定符	构造器和说明
protected	AioSocket(SocketContext parentSocketContext, AsynchronousSocketChannel socketChannel) 构造函数
	AioSocket(String host, int port, int readTimeout) 构造函数
	AioSocket(String host, int port, int readTimeout, int idleInterval) 构造函数

方法概要

限定符和类型	方法和说明
protected void	acceptStart() 用于针对 Accept 进来的 Socket 连接的启动
protected void	catchConnected() 捕获 Aio Connect
protected void	catchRead(ByteBuffer buffer) 捕获 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) 同步发送消息
void	syncStart() 启动同步的上下文连接 非阻塞方法

从类继承的方法 org.voovan.network.SocketContext

copyFrom, filterChain, getBufferSize, getConnectModel, getHost, getIdleInterval, getPort, getReadTimeout, getSSLManager, handler, handler, initSSL, messageSplitter, messageSplitter, setBufferSize, setSSLManager, waitConnected

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

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

构造器详细资料

AioSocket

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

构造函数

参数:

host - 主机地址

port - 主机端口

readTimeout - 主机超时时间 (milliseconds)

抛出:

IOException - IO 异常

AioSocket

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

构造函数

参数:

host - 主机地址

port - 主机端口

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

readTimeout - 主机超时时间 (milliseconds)

抛出:

IOException - IO 异常

AioSocket

protected AioSocket(SocketContext parentSocketContext,
                    AsynchronousSocketChannel socketChannel)
             throws IOException

构造函数

参数:

parentSocketContext - 父异步 socket 通道

socketChannel - 异步 socket 通道

抛出:

IOException - IO 异常

方法详细资料

setIdleInterval

public void setIdleInterval(int idleInterval)

从类复制的说明: SocketContext

设置空闲事件时间

指定者:

setIdleInterval 在类中 SocketContext

参数:

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

setOption

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

设置 Socket 的 Option 选项

指定者:

setOption 在类中 SocketContext

类型参数:

T - 范型

参数:

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

value - SocketOption参数

抛出:

IOException - IO异常

catchConnected

protected void catchConnected()
                       throws IOException

捕获 Aio Connect

抛出:

IOException - IO 异常

catchRead

protected void catchRead(ByteBuffer buffer)

捕获 Aio Read

参数:

buffer - 缓冲区

getSession

public AioSession getSession()

获取 Session 对象

返回:

Session 对象

start

public void start()
           throws IOException

启动上下文连接 阻塞方法

指定者:

start 在类中 SocketContext

抛出:

IOException - IO 异常

syncStart

public void syncStart()
               throws IOException

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

指定者:

syncStart 在类中 SocketContext

抛出:

IOException - IO异常

acceptStart

protected void acceptStart()
                    throws IOException

从类复制的说明: SocketContext

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

指定者:

acceptStart 在类中 SocketContext

抛出:

IOException - IO异常

restart

public AioSocket restart()
                  throws IOException,
                         RestartException

重连当前连接

返回:

AioSocket对象

抛出:

IOException - IO 异常

RestartException - 重新启动的异常

socketChannel

public AsynchronousSocketChannel socketChannel()

获取 SocketChannel 对象

返回:

异步 Socket 通道

isOpen

public boolean isOpen()

从类复制的说明: SocketContext

上下文连接是否打开

指定者:

isOpen 在类中 SocketContext

返回:

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

isConnected

public boolean isConnected()

从类复制的说明: SocketContext

上下文连接是否连接

指定者:

isConnected 在类中 SocketContext

返回:

true:连接,false:断开

synchronouRead

public Object synchronouRead()
                      throws ReadMessageException

同步读取消息

返回:

读取出的对象

抛出:

ReadMessageException - 读取消息异常

synchronouSend

public void synchronouSend(Object obj)
                    throws SendMessageException

同步发送消息

参数:

obj - 要发送的对象

抛出:

SendMessageException - 消息发送异常

close

public boolean close()

从类复制的说明: SocketContext

关闭连接

指定者:

close 在类中 SocketContext

返回:

是否关闭