org.smartboot.socket.transport

类 AioQuickClient

java.lang.Object

org.smartboot.socket.transport.AioQuickClient

public final class AioQuickClient
extends Object

AIO实现的客户端服务。

示例：

 public class IntegerClient {
      public static void main(String[] args) throws Exception {
          IntegerClientProcessor processor = new IntegerClientProcessor();
          AioQuickClient aioQuickClient = new AioQuickClient("localhost", 8888, new IntegerProtocol(), processor);
          aioQuickClient.start();
          processor.getSession().write(1);
          processor.getSession().close(false);//待数据发送完毕后关闭
          aioQuickClient.shutdown();
      }
 }
 

版本:

V1.0.0

作者:

三刀

构造器概要

构造器

构造器和说明
AioQuickClient(String host, int port, Protocol<T> protocol, MessageProcessor<T> messageProcessor) 当前构造方法设置了启动Aio客户端的必要参数，基本实现开箱即用。

方法概要

限定符和类型	方法和说明
AioQuickClient	bindLocal(String local, int port) 绑定本机地址、端口用于连接远程服务
AioQuickClient	connectTimeout(int timeout) 客户端连接超时时间，单位:毫秒
org.smartboot.socket.transport.TcpAioSession	getSession()
AioQuickClient	setBufferFactory(BufferFactory bufferFactory) 设置内存池的构造工厂。
AioQuickClient	setBufferPagePool(BufferPagePool bufferPool) 设置内存池。
<V> AioQuickClient	setOption(SocketOption<V> socketOption, V value) 设置Socket的TCP参数配置 AIO客户端的有效可选范围为： 1.
AioQuickClient	setReadBufferFactory(VirtualBufferFactory readBufferFactory)
AioQuickClient	setReadBufferSize(int size) 设置读缓存区大小
AioQuickClient	setWriteBuffer(int bufferSize, int bufferCapacity) 设置输出缓冲区容量
void	shutdown() 停止客户端服务.
void	shutdownNow() 立即关闭客户端
AioSession	start() 启动客户端。
<A> void	start(A attachment, CompletionHandler<AioSession,? super A> handler) 采用异步的方式启动客户端
AioSession	start(AsynchronousChannelGroup asynchronousChannelGroup) 启动客户端。
<A> void	start(AsynchronousChannelGroup asynchronousChannelGroup, A attachment, CompletionHandler<AioSession,? super A> handler) 采用异步的方式启动客户端

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

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

构造器详细资料

AioQuickClient

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

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

参数:

host - 远程服务器地址

port - 远程服务器端口号

protocol - 协议编解码

messageProcessor - 消息处理器

方法详细资料

start

public <A> void start(A attachment,
                      CompletionHandler<AioSession,? super A> handler)
               throws IOException

采用异步的方式启动客户端

类型参数:

A - 附件对象类型

参数:

attachment - 可传入回调方法中的附件对象

handler - 异步回调

抛出:

IOException

start

public <A> void start(AsynchronousChannelGroup asynchronousChannelGroup,
                      A attachment,
                      CompletionHandler<AioSession,? super A> handler)
               throws IOException

采用异步的方式启动客户端

类型参数:

A - 附件对象类型

参数:

asynchronousChannelGroup - 通信线程资源组

attachment - 可传入回调方法中的附件对象

handler - 异步回调

抛出:

IOException

start

public AioSession start(AsynchronousChannelGroup asynchronousChannelGroup)
                 throws IOException

启动客户端。

在与服务端建立连接期间，该方法处于阻塞状态。直至连接建立成功，或者发生异常。

该start方法支持外部指定AsynchronousChannelGroup，实现多个客户端共享一组线程池资源，有效提升资源利用率。

参数:

asynchronousChannelGroup - IO事件处理线程组

返回:

建立连接后的会话对象

抛出:

IOException - IOException

另请参阅:

AsynchronousSocketChannel.connect(SocketAddress)

getSession

public org.smartboot.socket.transport.TcpAioSession getSession()

start

public AioSession start()
                 throws IOException

启动客户端。

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

返回:

建立连接后的会话对象

抛出:

IOException - IOException

另请参阅:

start(AsynchronousChannelGroup)

shutdown

public void shutdown()

停止客户端服务.

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

shutdownNow

public void shutdownNow()

立即关闭客户端

setReadBufferSize

public AioQuickClient setReadBufferSize(int size)

设置读缓存区大小

参数:

size - 单位：byte

返回:

当前AIOQuickClient对象

setOption

public <V> AioQuickClient 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

类型参数:

V - 泛型

参数:

socketOption - 配置项

value - 配置值

返回:

当前客户端实例

bindLocal

public AioQuickClient bindLocal(String local,
                                int port)

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

参数:

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

port - 若传0则由系统指定

返回:

当前客户端实例

setBufferPagePool

public AioQuickClient setBufferPagePool(BufferPagePool bufferPool)

设置内存池。 通过该方法设置的内存池，在AioQuickClient执行shutdown时不会触发内存池的释放。 该方法适用于多个AioQuickServer、AioQuickClient共享内存池的场景。 在启用内存池的情况下会有更好的性能表现

参数:

bufferPool - 内存池对象

返回:

当前客户端实例

setBufferFactory

public AioQuickClient setBufferFactory(BufferFactory bufferFactory)

设置内存池的构造工厂。 通过工厂形式生成的内存池会强绑定到当前AioQuickClient对象， 在AioQuickClient执行shutdown时会释放内存池。 在启用内存池的情况下会有更好的性能表现

参数:

bufferFactory - 内存池工厂

返回:

当前客户端实例

setWriteBuffer

public AioQuickClient setWriteBuffer(int bufferSize,
                                     int bufferCapacity)

设置输出缓冲区容量

参数:

bufferSize - 单个内存块大小

bufferCapacity - 内存块数量上限

返回:

当前客户端实例

connectTimeout

public AioQuickClient connectTimeout(int timeout)

客户端连接超时时间，单位:毫秒

参数:

timeout - 超时时间

返回:

当前客户端实例

setReadBufferFactory

public final AioQuickClient setReadBufferFactory(VirtualBufferFactory readBufferFactory)