类的使用
org.tio.core.TioConfig

使用TioConfig的程序包

程序包	说明
org.tio.client
org.tio.cluster
org.tio.core
org.tio.core.cache
org.tio.core.intf
org.tio.core.maintain
org.tio.core.ssl
org.tio.core.stat
org.tio.server

org.tio.client中TioConfig的使用

org.tio.client中TioConfig的子类

限定符和类型	类和说明
class	ClientTioConfig

参数类型为TioConfig的org.tio.client中的构造器

构造器和说明
ClientChannelContext(TioConfig tioConfig) 创建一个虚拟ChannelContext，主要用来模拟一些操作，真实场景中用得少
ClientChannelContext(TioConfig tioConfig, AsynchronousSocketChannel asynchronousSocketChannel)

org.tio.cluster中TioConfig的使用

参数类型为TioConfig的org.tio.cluster中的构造器

构造器和说明
TioClusterMessageListener(TioConfig tioConfig)

org.tio.core中TioConfig的使用

声明为TioConfig的org.tio.core中的字段

限定符和类型	字段和说明
TioConfig	ChannelContext.tioConfig

类型参数类型为TioConfig的org.tio.core中的字段

限定符和类型	字段和说明
static Set<TioConfig>	TioConfig.ALL_GROUPCONTEXTS 本jvm中所有的TioConfig对象

返回TioConfig的org.tio.core中的方法

限定符和类型	方法和说明
TioConfig	ChannelContext.getTioConfig()

参数类型为TioConfig的org.tio.core中的方法

限定符和类型	方法和说明
static boolean	Tio.IpBlacklist.add(TioConfig tioConfig, String ip) 把ip添加到黑名单，此黑名单只针对tioConfig有效，其它tioConfig不会把这个ip视为黑名单
static void	Tio.bindGroup(TioConfig tioConfig, String userid, String group) 将用户绑定到群组
static Boolean	Tio.bSend(TioConfig tioConfig, String ip, int port, Packet packet) 发送到指定的ip和port
static Boolean	Tio.bSendToAll(TioConfig tioConfig, Packet packet, ChannelContextFilter channelContextFilter) 发消息到所有连接
static Boolean	Tio.bSendToBsId(TioConfig tioConfig, String bsId, Packet packet) 阻塞发消息给指定业务ID
static Boolean	Tio.bSendToGroup(TioConfig tioConfig, String group, Packet packet) 发消息到组
static Boolean	Tio.bSendToGroup(TioConfig tioConfig, String group, Packet packet, ChannelContextFilter channelContextFilter) 发消息到组
static Boolean	Tio.bSendToId(TioConfig tioConfig, String channelContextId, Packet packet) 发消息给指定ChannelContext id
static Boolean	Tio.bSendToIp(TioConfig tioConfig, String ip, Packet packet) 阻塞发送到指定ip对应的集合
static Boolean	Tio.bSendToIp(TioConfig tioConfig, String ip, Packet packet, ChannelContextFilter channelContextFilter) 阻塞发送到指定ip对应的集合
static Boolean	Tio.bSendToSet(TioConfig tioConfig, SetWithLock<ChannelContext> setWithLock, Packet packet, ChannelContextFilter channelContextFilter) 发消息到指定集合
static Boolean	Tio.bSendToToken(TioConfig tioConfig, String token, Packet packet) 阻塞发消息到指定token
static Boolean	Tio.bSendToUser(TioConfig tioConfig, String userid, Packet packet) 阻塞发消息给指定用户
static void	Tio.IpBlacklist.clear(TioConfig tioConfig) 清空黑名单，只针对tioConfig有效
static void	Tio.close(TioConfig tioConfig, String clientIp, Integer clientPort, Throwable throwable, String remark) 关闭连接
static void	Tio.closeGroup(TioConfig tioConfig, String group, String remark) 关闭某群所有连接
static void	Tio.closeGroup(TioConfig tioConfig, String group, String remark, ChannelContext.CloseCode closeCode) 关闭某群所有连接
static SetWithLock<ChannelContext>	Tio.getAll(TioConfig tioConfig) 获取所有连接，包括当前处于断开状态的
static Collection<String>	Tio.IpBlacklist.getAll(TioConfig tioConfig) 获取ip黑名单列表
static SetWithLock<ChannelContext>	Tio.getAllChannelContexts(TioConfig tioConfig) 已过时。 用getAll(TioConfig tioConfig)
static ChannelContext	Tio.getByBsId(TioConfig tioConfig, String bsId) 根据业务id找ChannelContext
static ChannelContext	Tio.getByChannelContextId(TioConfig tioConfig, String channelContextId) 根据ChannelContext.id获取ChannelContext
static ChannelContext	Tio.getByClientNode(TioConfig tioConfig, String clientIp, Integer clientPort) 根据clientip和clientport获取ChannelContext
static SetWithLock<ChannelContext>	Tio.getByGroup(TioConfig tioConfig, String group) 获取一个组的所有客户端
static SetWithLock<ChannelContext>	Tio.getByToken(TioConfig tioConfig, String token) 根据token获取SetWithLock
static SetWithLock<ChannelContext>	Tio.getByUserid(TioConfig tioConfig, String userid) 根据userid获取SetWithLock
static ChannelContext	Tio.getChannelContextByBsId(TioConfig tioConfig, String bsId) 已过时。 用getByBsId(TioConfig tioConfig, String bsId)
static ChannelContext	Tio.getChannelContextByClientNode(TioConfig tioConfig, String clientIp, Integer clientPort) 已过时。 getByClientNode(tioConfig, clientIp, clientPort)
static ChannelContext	Tio.getChannelContextById(TioConfig tioConfig, String channelContextId) 已过时。 用getByChannelContextId(tioConfig, channelContextId)
static SetWithLock<ChannelContext>	Tio.getChannelContextsByGroup(TioConfig tioConfig, String group) 已过时。 用getByGroup(tioConfig, group)
static SetWithLock<ChannelContext>	Tio.getChannelContextsByToken(TioConfig tioConfig, String token) 已过时。 用getByToken(tioConfig, token)
static SetWithLock<ChannelContext>	Tio.getChannelContextsByUserid(TioConfig tioConfig, String userid) 已过时。 用getByUserid(tioConfig, userid)
static Page<ChannelContext>	Tio.getPageOfAll(TioConfig tioConfig, Integer pageIndex, Integer pageSize)
static <T> Page<T>	Tio.getPageOfAll(TioConfig tioConfig, Integer pageIndex, Integer pageSize, Converter<T> converter)
static Page<ChannelContext>	Tio.getPageOfGroup(TioConfig tioConfig, String group, Integer pageIndex, Integer pageSize)
static <T> Page<T>	Tio.getPageOfGroup(TioConfig tioConfig, String group, Integer pageIndex, Integer pageSize, Converter<T> converter)
static int	Tio.groupCount(TioConfig tioConfig, String group) 群组有多少个连接
void	ChannelContext.init(TioConfig tioConfig, AsynchronousSocketChannel asynchronousSocketChannel)
static boolean	Tio.IpBlacklist.isInBlacklist(TioConfig tioConfig, String ip) 是否在黑名单中
static void	Tio.notifyClusterForBsId(TioConfig tioConfig, String bsId, Packet packet)
static void	Tio.notifyClusterForGroup(TioConfig tioConfig, String group, Packet packet) 在集群环境下，把群组消息通知到集群中的其它机器
static void	Tio.notifyClusterForId(TioConfig tioConfig, String channelContextId, Packet packet) 在集群环境下，把channelContextId消息通知到集群中的其它机器
static void	Tio.notifyClusterForIp(TioConfig tioConfig, String ip, Packet packet) 在集群环境下，把IP消息通知到集群中的其它机器
static void	Tio.notifyClusterForToken(TioConfig tioConfig, String token, Packet packet) 在集群环境下，把token消息通知到集群中的其它机器
static void	Tio.notifyClusterForUser(TioConfig tioConfig, String userid, Packet packet) 在集群环境下，把userid消息通知到集群中的其它机器
static void	Tio.IpBlacklist.remove(TioConfig tioConfig, String ip) 把ip从黑名单中删除
static void	Tio.remove(TioConfig tioConfig, String clientIp, Integer clientPort, Throwable throwable, String remark) 和close方法对应，只不过不再进行重连等维护性的操作
static void	Tio.remove(TioConfig tioConfig, String clientIp, Integer clientPort, Throwable throwable, String remark, ChannelContext.CloseCode closeCode) 删除clientip和clientPort为指定值的连接
static Boolean	Tio.send(TioConfig tioConfig, String ip, int port, Packet packet) 发送到指定的ip和port
static void	Tio.sendToAll(TioConfig tioConfig, Packet packet)
static void	Tio.sendToAll(TioConfig tioConfig, Packet packet, ChannelContextFilter channelContextFilter) 发消息到所有连接
static Boolean	Tio.sendToBsId(TioConfig tioConfig, String bsId, Packet packet) 发消息给指定业务ID
static void	Tio.sendToGroup(TioConfig tioConfig, String group, Packet packet) 发消息到组
static void	Tio.sendToGroup(TioConfig tioConfig, String group, Packet packet, ChannelContextFilter channelContextFilter) 发消息到组
static Boolean	Tio.sendToId(TioConfig tioConfig, String channelContextId, Packet packet) 发消息给指定ChannelContext id
static void	Tio.sendToIp(TioConfig tioConfig, String ip, Packet packet) 发送到指定ip对应的集合
static void	Tio.sendToIp(TioConfig tioConfig, String ip, Packet packet, ChannelContextFilter channelContextFilter) 发送到指定ip对应的集合
static void	Tio.sendToSet(TioConfig tioConfig, SetWithLock<ChannelContext> setWithLock, Packet packet, ChannelContextFilter channelContextFilter) 发消息到指定集合
static Boolean	Tio.sendToToken(TioConfig tioConfig, String token, Packet packet) 发消息到指定token
static Boolean	Tio.sendToUser(TioConfig tioConfig, String userid, Packet packet) 发消息给指定用户
void	ChannelContext.setTioConfig(TioConfig tioConfig)
static void	Tio.unbindGroup(TioConfig tioConfig, String userid, String group) 将某用户从组中解除绑定
static void	Tio.unbindToken(TioConfig tioConfig, String token) 解除token
static void	Tio.unbindUser(TioConfig tioConfig, String userid) 解除userid的绑定。

参数类型为TioConfig的org.tio.core中的构造器

构造器和说明
ChannelContext(TioConfig tioConfig) 创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少
ChannelContext(TioConfig tioConfig, AsynchronousSocketChannel asynchronousSocketChannel)
ChannelContext(TioConfig tioConfig, String id) 创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少

org.tio.core.cache中TioConfig的使用

参数类型为TioConfig的org.tio.core.cache中的构造器

构造器和说明
IpStatRemovalListener(TioConfig tioConfig, IpStatListener ipStatListener)

org.tio.core.intf中TioConfig的使用

参数类型为TioConfig的org.tio.core.intf中的方法

限定符和类型	方法和说明
ByteBuffer	AioHandler.encode(Packet packet, TioConfig tioConfig, ChannelContext channelContext) 编码

org.tio.core.maintain中TioConfig的使用

参数类型为TioConfig的org.tio.core.maintain中的方法

限定符和类型	方法和说明
SetWithLock<ChannelContext>	Ips.clients(TioConfig tioConfig, String ip) 一个ip有哪些客户端，有可能返回null
SetWithLock<ChannelContext>	Groups.clients(TioConfig tioConfig, String groupid) 一个组有哪些客户端
SetWithLock<ChannelContext>	Users.find(TioConfig tioConfig, String userid) Find.
SetWithLock<ChannelContext>	Tokens.find(TioConfig tioConfig, String token) Find.
ChannelContext	Ids.find(TioConfig tioConfig, String id) Find.
ChannelContext	BsIds.find(TioConfig tioConfig, String bsId)
void	Users.unbind(TioConfig tioConfig, String userid) 解除tioConfig范围内所有ChannelContext的 userid绑定
void	Tokens.unbind(TioConfig tioConfig, String token) 解除tioConfig范围内所有ChannelContext的 token绑定

参数类型为TioConfig的org.tio.core.maintain中的构造器

构造器和说明
IpStats(TioConfig tioConfig, Long[] durations)

org.tio.core.ssl中TioConfig的使用

参数类型为TioConfig的org.tio.core.ssl中的方法

限定符和类型	方法和说明
static boolean	SslUtils.isSsl(TioConfig tioConfig) 是否是SSL连接
static boolean	SslUtils.needSslEncrypt(Packet packet, TioConfig tioConfig) 是否需要对这个packet进行SSL加密

org.tio.core.stat中TioConfig的使用

参数类型为TioConfig的org.tio.core.stat中的方法

限定符和类型	方法和说明
void	IpStatListener.onExpired(TioConfig tioConfig, IpStat ipStat) 统计时间段到期后，用户可以在这个方法中实现把相关数据入库或是打日志等
void	DefaultIpStatListener.onExpired(TioConfig tioConfig, IpStat ipStat)

org.tio.server中TioConfig的使用

org.tio.server中TioConfig的子类

限定符和类型	类和说明
class	ServerTioConfig

参数类型为TioConfig的org.tio.server中的构造器

构造器和说明
ServerChannelContext(TioConfig tioConfig) 创建一个虚拟ChannelContext，主要用来模拟一些操作，真实场景中用得少
ServerChannelContext(TioConfig tioConfig, AsynchronousSocketChannel asynchronousSocketChannel)
ServerChannelContext(TioConfig tioConfig, String id) 创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少