org.smartboot.socket.transport

类 AioQuickServer

java.lang.Object

org.smartboot.socket.transport.AioQuickServer

public final class AioQuickServer
extends Object

AIO服务端。

示例：

 public class IntegerServer {
     public static void main(String[] args) throws IOException {
         AioQuickServer server = new AioQuickServer(8888, new IntegerProtocol(), new IntegerServerProcessor());
         server.start();
     }
 }
 

版本:

V1.0.0

作者:

三刀

构造器概要

构造器

构造器和说明
AioQuickServer(int port, Protocol<T> protocol, MessageProcessor<T> messageProcessor) 设置服务端启动必要参数配置
AioQuickServer(String host, int port, Protocol<T> protocol, MessageProcessor<T> messageProcessor)

方法概要

限定符和类型	方法和说明
AioQuickServer	setBacklog(int backlog) 设置 backlog 大小
AioQuickServer	setBannerEnabled(boolean bannerEnabled) 是否启用控制台Banner打印
AioQuickServer	setBufferFactory(BufferFactory bufferFactory) 设置内存池的构造工厂。
AioQuickServer	setBufferPagePool(BufferPagePool bufferPool) 设置内存池。
AioQuickServer	setLowMemory(boolean lowMemory)
<V> AioQuickServer	setOption(SocketOption<V> socketOption, V value) 设置Socket的TCP参数配置。
AioQuickServer	setReadBufferFactory(VirtualBufferFactory readBufferFactory)
AioQuickServer	setReadBufferSize(int size) 设置读缓存区大小
AioQuickServer	setThreadNum(int threadNum) 设置服务工作线程数,设置数值必须大于等于2
AioQuickServer	setWriteBuffer(int bufferSize, int bufferCapacity) 设置输出缓冲区容量
void	shutdown() 停止服务端
void	start() 启动Server端的AIO服务
void	start(AsynchronousChannelGroup asynchronousChannelGroup) 内部启动逻辑

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

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

构造器详细资料

AioQuickServer

public AioQuickServer(int port,
                      Protocol<T> protocol,
                      MessageProcessor<T> messageProcessor)

设置服务端启动必要参数配置

参数:

port - 绑定服务端口号

protocol - 协议编解码

messageProcessor - 消息处理器

AioQuickServer

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

参数:

host - 绑定服务端Host地址

port - 绑定服务端口号

protocol - 协议编解码

messageProcessor - 消息处理器

方法详细资料

start

public void start()
           throws IOException

启动Server端的AIO服务

抛出:

IOException - IO异常

start

public void start(AsynchronousChannelGroup asynchronousChannelGroup)
           throws IOException

内部启动逻辑

抛出:

IOException - IO异常

shutdown

public void shutdown()

停止服务端

setReadBufferSize

public final AioQuickServer setReadBufferSize(int size)

设置读缓存区大小

参数:

size - 单位：byte

返回:

当前AioQuickServer对象

setBannerEnabled

public final AioQuickServer setBannerEnabled(boolean bannerEnabled)

是否启用控制台Banner打印

参数:

bannerEnabled - true:启用，false:禁用

返回:

当前AioQuickServer对象

setOption

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

设置Socket的TCP参数配置。

AIO客户端的有效可选范围为：
2. StandardSocketOptions.SO_RCVBUF
4. StandardSocketOptions.SO_REUSEADDR

类型参数:

V - 配置项类型

参数:

socketOption - 配置项

value - 配置值

返回:

当前AioQuickServer对象

setThreadNum

public final AioQuickServer setThreadNum(int threadNum)

设置服务工作线程数,设置数值必须大于等于2

参数:

threadNum - 线程数

返回:

当前AioQuickServer对象

setWriteBuffer

public final AioQuickServer setWriteBuffer(int bufferSize,
                                           int bufferCapacity)

设置输出缓冲区容量

参数:

bufferSize - 单个内存块大小

bufferCapacity - 内存块数量上限

返回:

当前AioQuickServer对象

setBacklog

public final AioQuickServer setBacklog(int backlog)

设置 backlog 大小

参数:

backlog - backlog大小

返回:

当前AioQuickServer对象

setBufferPagePool

public final AioQuickServer setBufferPagePool(BufferPagePool bufferPool)

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

参数:

bufferPool - 内存池对象

返回:

当前AioQuickServer对象

setBufferFactory

public final AioQuickServer setBufferFactory(BufferFactory bufferFactory)

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

参数:

bufferFactory - 内存池工厂

返回:

当前AioQuickServer对象

setReadBufferFactory

public final AioQuickServer setReadBufferFactory(VirtualBufferFactory readBufferFactory)

setLowMemory

public AioQuickServer setLowMemory(boolean lowMemory)