org.aoju.bus.socket.origin

Class AioQuickClient<T>

java.lang.Object

org.aoju.bus.socket.origin.AioQuickClient<T>

Direct Known Subclasses:

AioSSLQuickClient

public class AioQuickClient<T>
extends Object

AIO实现的客户端服务

Since:

JDK 1.8+

Version:

5.5.9

Author:

Kimi Liu

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferPool	bufferPool
protected org.aoju.bus.socket.origin.ServerConfig<T>	config 客户端服务配置 调用AioQuickClient的各setXX()方法,都是为了设置config的各配置项
protected org.aoju.bus.socket.origin.TcpAioSession<T>	session 网络连接的会话对象

Constructor Summary

Constructors

Constructor and Description
AioQuickClient(String host, int port, Protocol<T> protocol, Message<T> messageProcessor) 当前构造方法设置了启动Aio客户端的必要参数,基本实现开箱即用

Method Summary

Modifier and Type	Method and Description
AioQuickClient<T>	bindLocal(String local, int port) 绑定本机地址、端口用于连接远程服务
AioQuickClient<T>	setBufferPagePool(BufferPool bufferPool)
<V> AioQuickClient<T>	setOption(SocketOption<V> socketOption, V value) 设置Socket的TCP参数配置 AIO客户端的有效可选范围为： 1.
AioQuickClient<T>	setReadBufferSize(int size) 设置读缓存区大小
AioQuickClient<T>	setWriteQueueCapacity(int writeQueueCapacity) 设置write缓冲区容量
void	shutdown() 停止客户端服务.
void	shutdownNow() 立即关闭客户端
AioSession<T>	start() 启动客户端 本方法会构建线程数为2的asynchronousChannelGroup, 并通过调用 start(AsynchronousChannelGroup)启动服务
AioSession<T>	start(AsynchronousChannelGroup asynchronousChannelGroup) 启动客户端 在与服务端建立连接期间,该方法处于阻塞状态 直至连接建立成功,或者发生异常 该start方法支持外部指定AsynchronousChannelGroup,实现多个客户端共享一组线程池资源,有效提升资源利用率

Methods inherited from class java.lang.Object

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

Field Detail

config

protected org.aoju.bus.socket.origin.ServerConfig<T> config

客户端服务配置 调用AioQuickClient的各setXX()方法,都是为了设置config的各配置项

session

protected org.aoju.bus.socket.origin.TcpAioSession<T> session

网络连接的会话对象

See Also:

TcpAioSession

bufferPool

protected BufferPool bufferPool

Constructor Detail

AioQuickClient

public AioQuickClient(String host,
                      int port,
                      Protocol<T> protocol,
                      Message<T> messageProcessor)

当前构造方法设置了启动Aio客户端的必要参数,基本实现开箱即用

Parameters:

host - 远程服务器地址

port - 远程服务器端口号

protocol - 协议编解码

messageProcessor - 消息处理器

Method Detail

start

public AioSession<T> start(AsynchronousChannelGroup asynchronousChannelGroup)
                    throws IOException,
                           ExecutionException,
                           InterruptedException

启动客户端 在与服务端建立连接期间,该方法处于阻塞状态 直至连接建立成功,或者发生异常 该start方法支持外部指定AsynchronousChannelGroup,实现多个客户端共享一组线程池资源,有效提升资源利用率

Parameters:

asynchronousChannelGroup - IO事件处理线程组

Returns:

the object

Throws:

IOException - 异常

ExecutionException - 异常

InterruptedException - 异常

See Also:

AsynchronousSocketChannel.connect(SocketAddress)

start

public final AioSession<T> start()
                          throws IOException,
                                 ExecutionException,
                                 InterruptedException

启动客户端 本方法会构建线程数为2的asynchronousChannelGroup, 并通过调用 start(AsynchronousChannelGroup)启动服务

Returns:

the object

Throws:

IOException - 异常

ExecutionException - 异常

InterruptedException - 异常

See Also:

start(AsynchronousChannelGroup)

shutdown

public final void shutdown()

停止客户端服务. 调用该方法会触发AioSession的close方法,并且如果当前客户端若是通过执行 start()方法构建的, 同时会触发asynchronousChannelGroup的shutdown动作

shutdownNow

public final void shutdownNow()

立即关闭客户端

setReadBufferSize

public final AioQuickClient<T> setReadBufferSize(int size)

设置读缓存区大小

Parameters:

size - 单位：byte

Returns:

the object

setOption

public final <V> AioQuickClient<T> setOption(SocketOption<V> socketOption,
                                             V value)

设置Socket的TCP参数配置 AIO客户端的有效可选范围为： 1. StandardSocketOptions.SO_SNDBUF 2. StandardSocketOptions.SO_RCVBUF 3. StandardSocketOptions.SO_KEEPALIVE 4. StandardSocketOptions.SO_REUSEADDR 5. StandardSocketOptions.TCP_NODELAY

Type Parameters:

V - 对象

Parameters:

socketOption - 配置项

value - 配置值

Returns:

the object

bindLocal

public final AioQuickClient<T> bindLocal(String local,
                                         int port)

绑定本机地址、端口用于连接远程服务

Parameters:

local - 若传null则由系统自动获取

port - 若传0则由系统指定

Returns:

the object

setBufferPagePool

public final AioQuickClient<T> setBufferPagePool(BufferPool bufferPool)

setWriteQueueCapacity

public final AioQuickClient<T> setWriteQueueCapacity(int writeQueueCapacity)

设置write缓冲区容量

Parameters:

writeQueueCapacity - 缓冲区大小

Returns:

the object