org.tio.core

类 Tio

java.lang.Object

org.tio.core.Tio

public class Tio
extends Object

The Class Tio. t-io用户关心的API几乎全在这

作者:

tanyaowu

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	Tio.IpBlacklist

方法概要

限定符和类型	方法和说明
static void	bindBsId(ChannelContext channelContext, String bsId) 绑定业务id
static void	bindGroup(ChannelContext channelContext, String group) 绑定群组
static void	bindToken(ChannelContext channelContext, String token) 绑定token
static void	bindUser(ChannelContext channelContext, String userid) 绑定用户
static Boolean	bSend(ChannelContext channelContext, Packet packet) 阻塞发送消息到指定ChannelContext
static Boolean	bSend(GroupContext groupContext, String ip, int port, Packet packet) 发送到指定的ip和port
static Boolean	bSendToAll(GroupContext groupContext, Packet packet, ChannelContextFilter channelContextFilter) 发消息到所有连接
static Boolean	bSendToBsId(GroupContext groupContext, String bsId, Packet packet) 阻塞发消息给指定业务ID
static Boolean	bSendToGroup(GroupContext groupContext, String group, Packet packet) 发消息到组
static Boolean	bSendToGroup(GroupContext groupContext, String group, Packet packet, ChannelContextFilter channelContextFilter) 发消息到组
static Boolean	bSendToId(GroupContext groupContext, String channelId, Packet packet) 发消息给指定ChannelContext id
static Boolean	bSendToIp(GroupContext groupContext, String ip, Packet packet) 阻塞发送到指定ip对应的集合
static Boolean	bSendToIp(GroupContext groupContext, String ip, Packet packet, ChannelContextFilter channelContextFilter) 阻塞发送到指定ip对应的集合
static Boolean	bSendToSet(GroupContext groupContext, SetWithLock<ChannelContext> setWithLock, Packet packet, ChannelContextFilter channelContextFilter) 发消息到指定集合
static Boolean	bSendToToken(GroupContext groupContext, String token, Packet packet) 阻塞发消息到指定token
static Boolean	bSendToUser(GroupContext groupContext, String userid, Packet packet) 阻塞发消息给指定用户
static void	close(ChannelContext channelContext, String remark) 关闭连接
static void	close(ChannelContext channelContext, Throwable throwable, String remark) 关闭连接
static void	close(GroupContext groupContext, String clientIp, Integer clientPort, Throwable throwable, String remark) 关闭连接
static SetWithLock<ChannelContext>	getAllChannelContexts(GroupContext groupContext) 获取所有连接，包括当前处于断开状态的
static SetWithLock<ChannelContext>	getAllConnectedsChannelContexts(ClientGroupContext clientGroupContext) 获取所有处于正常连接状态的连接
static ChannelContext	getChannelContextByBsId(GroupContext groupContext, String bsId) 根据业务id找ChannelContext
static ChannelContext	getChannelContextByClientNode(GroupContext groupContext, String clientIp, Integer clientPort) 根据clientip和clientport获取ChannelContext
static ChannelContext	getChannelContextById(GroupContext groupContext, String channelId) 根据id获取ChannelContext
static SetWithLock<ChannelContext>	getChannelContextsByGroup(GroupContext groupContext, String group) 获取一个组的所有客户端
static SetWithLock<ChannelContext>	getChannelContextsByToken(GroupContext groupContext, String token) 根据token获取SetWithLock
static SetWithLock<ChannelContext>	getChannelContextsByUserid(GroupContext groupContext, String userid) 根据userid获取SetWithLock
static Page<ChannelContext>	getPageOfAll(GroupContext groupContext, Integer pageIndex, Integer pageSize)
static <T> Page<T>	getPageOfAll(GroupContext groupContext, Integer pageIndex, Integer pageSize, Converter<T> converter)
static Page<ChannelContext>	getPageOfConnecteds(ClientGroupContext clientGroupContext, Integer pageIndex, Integer pageSize) 这个方法是给服务器端用的
static <T> Page<T>	getPageOfConnecteds(ClientGroupContext clientGroupContext, Integer pageIndex, Integer pageSize, Converter<T> converter)
static Page<ChannelContext>	getPageOfGroup(GroupContext groupContext, String group, Integer pageIndex, Integer pageSize)
static <T> Page<T>	getPageOfGroup(GroupContext groupContext, String group, Integer pageIndex, Integer pageSize, Converter<T> converter)
static int	groupCount(GroupContext groupContext, String group) 群组有多少个连接
static boolean	isInGroup(String group, ChannelContext channelContext) 某通道是否在某群组中
static void	notifyClusterForBsId(GroupContext groupContext, String bsId, Packet packet)
static void	notifyClusterForGroup(GroupContext groupContext, String group, Packet packet) 在集群环境下，把群组消息通知到集群中的其它机器
static void	notifyClusterForId(GroupContext groupContext, String channelId, Packet packet) 在集群环境下，把channelId消息通知到集群中的其它机器
static void	notifyClusterForIp(GroupContext groupContext, String ip, Packet packet) 在集群环境下，把IP消息通知到集群中的其它机器
static void	notifyClusterForToken(GroupContext groupContext, String token, Packet packet) 在集群环境下，把token消息通知到集群中的其它机器
static void	notifyClusterForUser(GroupContext groupContext, String userid, Packet packet) 在集群环境下，把userid消息通知到集群中的其它机器
static void	remove(ChannelContext channelContext, String remark) 和close方法一样，只不过不再进行重连等维护性的操作
static void	remove(ChannelContext channelContext, Throwable throwable, String remark) 和close方法一样，只不过不再进行重连等维护性的操作
static void	remove(GroupContext groupContext, String clientIp, Integer clientPort, Throwable throwable, String remark) 和close方法一样，只不过不再进行重连等维护性的操作
static void	remove(GroupContext groupContext, String ip, String remark) 删除client ip为指定值的所有连接
static Boolean	send(ChannelContext channelContext, Packet packet) 发送消息到指定ChannelContext
static Boolean	send(GroupContext groupContext, String ip, int port, Packet packet) 发送到指定的ip和port
static void	sendToAll(GroupContext groupContext, Packet packet)
static void	sendToAll(GroupContext groupContext, Packet packet, ChannelContextFilter channelContextFilter) 发消息到所有连接
static Boolean	sendToBsId(GroupContext groupContext, String bsId, Packet packet) 发消息给指定业务ID
static void	sendToGroup(GroupContext groupContext, String group, Packet packet) 发消息到组
static void	sendToGroup(GroupContext groupContext, String group, Packet packet, ChannelContextFilter channelContextFilter) 发消息到组
static Boolean	sendToId(GroupContext groupContext, String channelId, Packet packet) 发消息给指定ChannelContext id
static void	sendToIp(GroupContext groupContext, String ip, Packet packet) 发送到指定ip对应的集合
static void	sendToIp(GroupContext groupContext, String ip, Packet packet, ChannelContextFilter channelContextFilter) 发送到指定ip对应的集合
static void	sendToSet(GroupContext groupContext, SetWithLock<ChannelContext> setWithLock, Packet packet, ChannelContextFilter channelContextFilter) 发消息到指定集合
static Boolean	sendToToken(GroupContext groupContext, String token, Packet packet) 发消息到指定token
static Boolean	sendToUser(GroupContext groupContext, String userid, Packet packet) 发消息给指定用户
static Packet	synSend(ChannelContext channelContext, Packet packet, long timeout) 发送并等待响应.
static void	unbindBsId(ChannelContext channelContext) 解绑业务id
static void	unbindGroup(ChannelContext channelContext) 与所有组解除解绑关系
static void	unbindGroup(String group, ChannelContext channelContext) 与指定组解除绑定关系
static void	unbindToken(ChannelContext channelContext) 解除channelContext绑定的token
static void	unbindUser(ChannelContext channelContext) 解除channelContext绑定的userid
static void	unbindUser(GroupContext groupContext, String userid) 解除userid的绑定。

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

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

方法详细资料

bindGroup

public static void bindGroup(ChannelContext channelContext,
                             String group)

绑定群组

参数:

channelContext -

group -

isInGroup

public static boolean isInGroup(String group,
                                ChannelContext channelContext)

某通道是否在某群组中

参数:

group -

channelContext -

返回:

true：在该群组

groupCount

public static int groupCount(GroupContext groupContext,
                             String group)

群组有多少个连接

参数:

groupContext -

group -

返回:

bindUser

public static void bindUser(ChannelContext channelContext,
                            String userid)

绑定用户

参数:

channelContext -

userid -

bindToken

public static void bindToken(ChannelContext channelContext,
                             String token)

绑定token

参数:

channelContext -

token -

bindBsId

public static void bindBsId(ChannelContext channelContext,
                            String bsId)

绑定业务id

参数:

channelContext -

bsId -

unbindBsId

public static void unbindBsId(ChannelContext channelContext)

解绑业务id

参数:

channelContext -

getChannelContextByBsId

public static ChannelContext getChannelContextByBsId(GroupContext groupContext,
                                                     String bsId)

根据业务id找ChannelContext

参数:

groupContext -

bsId -

返回:

sendToBsId

public static Boolean sendToBsId(GroupContext groupContext,
                                 String bsId,
                                 Packet packet)

发消息给指定业务ID

参数:

groupContext -

bsId -

packet -

返回:

notifyClusterForBsId

public static void notifyClusterForBsId(GroupContext groupContext,
                                        String bsId,
                                        Packet packet)

参数:

groupContext -

bsId -

packet -

bSendToBsId

public static Boolean bSendToBsId(GroupContext groupContext,
                                  String bsId,
                                  Packet packet)

阻塞发消息给指定业务ID

参数:

groupContext -

bsId -

packet -

bSend

public static Boolean bSend(ChannelContext channelContext,
                            Packet packet)

阻塞发送消息到指定ChannelContext

参数:

channelContext -

packet -

返回:

bSend

public static Boolean bSend(GroupContext groupContext,
                            String ip,
                            int port,
                            Packet packet)

发送到指定的ip和port

参数:

groupContext -

ip -

port -

packet -

bSendToAll

public static Boolean bSendToAll(GroupContext groupContext,
                                 Packet packet,
                                 ChannelContextFilter channelContextFilter)

发消息到所有连接

参数:

groupContext -

packet -

channelContextFilter -

bSendToGroup

public static Boolean bSendToGroup(GroupContext groupContext,
                                   String group,
                                   Packet packet)

发消息到组

参数:

groupContext -

group -

packet -

bSendToGroup

public static Boolean bSendToGroup(GroupContext groupContext,
                                   String group,
                                   Packet packet,
                                   ChannelContextFilter channelContextFilter)

发消息到组

参数:

groupContext -

group -

packet -

channelContextFilter -

bSendToId

public static Boolean bSendToId(GroupContext groupContext,
                                String channelId,
                                Packet packet)

发消息给指定ChannelContext id

参数:

channelId -

packet -

bSendToSet

public static Boolean bSendToSet(GroupContext groupContext,
                                 SetWithLock<ChannelContext> setWithLock,
                                 Packet packet,
                                 ChannelContextFilter channelContextFilter)

发消息到指定集合

参数:

groupContext -

setWithLock -

packet -

channelContextFilter -

bSendToUser

public static Boolean bSendToUser(GroupContext groupContext,
                                  String userid,
                                  Packet packet)

阻塞发消息给指定用户

参数:

groupContext -

userid -

packet -

返回:

bSendToToken

public static Boolean bSendToToken(GroupContext groupContext,
                                   String token,
                                   Packet packet)

阻塞发消息到指定token

参数:

groupContext -

token -

packet -

返回:

close

public static void close(ChannelContext channelContext,
                         String remark)

关闭连接

参数:

channelContext -

remark -

close

public static void close(ChannelContext channelContext,
                         Throwable throwable,
                         String remark)

关闭连接

参数:

channelContext -

throwable -

remark -

close

public static void close(GroupContext groupContext,
                         String clientIp,
                         Integer clientPort,
                         Throwable throwable,
                         String remark)

关闭连接

参数:

groupContext -

clientIp -

clientPort -

throwable -

remark -

getAllChannelContexts

public static SetWithLock<ChannelContext> getAllChannelContexts(GroupContext groupContext)

获取所有连接，包括当前处于断开状态的

参数:

groupContext -

返回:

getAllConnectedsChannelContexts

public static SetWithLock<ChannelContext> getAllConnectedsChannelContexts(ClientGroupContext clientGroupContext)

获取所有处于正常连接状态的连接

参数:

clientGroupContext -

返回:

getChannelContextByClientNode

public static ChannelContext getChannelContextByClientNode(GroupContext groupContext,
                                                           String clientIp,
                                                           Integer clientPort)

根据clientip和clientport获取ChannelContext

参数:

groupContext -

clientIp -

clientPort -

返回:

getChannelContextById

public static ChannelContext getChannelContextById(GroupContext groupContext,
                                                   String channelId)

根据id获取ChannelContext

参数:

channelId -

返回:

getChannelContextsByUserid

public static SetWithLock<ChannelContext> getChannelContextsByUserid(GroupContext groupContext,
                                                                     String userid)

根据userid获取SetWithLock

参数:

groupContext -

userid -

返回:

getChannelContextsByToken

public static SetWithLock<ChannelContext> getChannelContextsByToken(GroupContext groupContext,
                                                                    String token)

根据token获取SetWithLock

参数:

groupContext -

token -

返回:

getChannelContextsByGroup

public static SetWithLock<ChannelContext> getChannelContextsByGroup(GroupContext groupContext,
                                                                    String group)

获取一个组的所有客户端

参数:

groupContext -

group -

返回:

getPageOfAll

public static Page<ChannelContext> getPageOfAll(GroupContext groupContext,
                                                Integer pageIndex,
                                                Integer pageSize)

参数:

groupContext -

pageIndex -

pageSize -

返回:

getPageOfAll

public static <T> Page<T> getPageOfAll(GroupContext groupContext,
                                       Integer pageIndex,
                                       Integer pageSize,
                                       Converter<T> converter)

参数:

groupContext -

pageIndex -

pageSize -

converter -

返回:

getPageOfConnecteds

public static Page<ChannelContext> getPageOfConnecteds(ClientGroupContext clientGroupContext,
                                                       Integer pageIndex,
                                                       Integer pageSize)

这个方法是给服务器端用的

参数:

clientGroupContext -

pageIndex -

pageSize -

返回:

getPageOfConnecteds

public static <T> Page<T> getPageOfConnecteds(ClientGroupContext clientGroupContext,
                                              Integer pageIndex,
                                              Integer pageSize,
                                              Converter<T> converter)

参数:

clientGroupContext -

pageIndex -

pageSize -

converter -

返回:

getPageOfGroup

public static Page<ChannelContext> getPageOfGroup(GroupContext groupContext,
                                                  String group,
                                                  Integer pageIndex,
                                                  Integer pageSize)

参数:

groupContext -

group -

pageIndex -

pageSize -

返回:

getPageOfGroup

public static <T> Page<T> getPageOfGroup(GroupContext groupContext,
                                         String group,
                                         Integer pageIndex,
                                         Integer pageSize,
                                         Converter<T> converter)

参数:

groupContext -

group -

pageIndex -

pageSize -

converter -

返回:

remove

public static void remove(ChannelContext channelContext,
                          String remark)

和close方法一样，只不过不再进行重连等维护性的操作

参数:

channelContext -

remark -

remove

public static void remove(GroupContext groupContext,
                          String ip,
                          String remark)

删除client ip为指定值的所有连接

参数:

groupContext -

ip -

remark -

remove

public static void remove(ChannelContext channelContext,
                          Throwable throwable,
                          String remark)

和close方法一样，只不过不再进行重连等维护性的操作

参数:

channelContext -

throwable -

remark -

remove

public static void remove(GroupContext groupContext,
                          String clientIp,
                          Integer clientPort,
                          Throwable throwable,
                          String remark)

和close方法一样，只不过不再进行重连等维护性的操作

参数:

groupContext -

clientIp -

clientPort -

throwable -

remark -

send

public static Boolean send(ChannelContext channelContext,
                           Packet packet)

发送消息到指定ChannelContext

参数:

channelContext -

packet -

send

public static Boolean send(GroupContext groupContext,
                           String ip,
                           int port,
                           Packet packet)

发送到指定的ip和port

参数:

groupContext -

ip -

port -

packet -

sendToAll

public static void sendToAll(GroupContext groupContext,
                             Packet packet)

sendToAll

public static void sendToAll(GroupContext groupContext,
                             Packet packet,
                             ChannelContextFilter channelContextFilter)

发消息到所有连接

参数:

groupContext -

packet -

channelContextFilter -

sendToGroup

public static void sendToGroup(GroupContext groupContext,
                               String group,
                               Packet packet)

发消息到组

参数:

groupContext -

group -

packet -

sendToGroup

public static void sendToGroup(GroupContext groupContext,
                               String group,
                               Packet packet,
                               ChannelContextFilter channelContextFilter)

发消息到组

参数:

groupContext -

group -

packet -

channelContextFilter -

notifyClusterForGroup

public static void notifyClusterForGroup(GroupContext groupContext,
                                         String group,
                                         Packet packet)

在集群环境下，把群组消息通知到集群中的其它机器

参数:

groupContext -

group -

packet -

bSendToIp

public static Boolean bSendToIp(GroupContext groupContext,
                                String ip,
                                Packet packet)

阻塞发送到指定ip对应的集合

参数:

groupContext -

ip -

packet -

bSendToIp

public static Boolean bSendToIp(GroupContext groupContext,
                                String ip,
                                Packet packet,
                                ChannelContextFilter channelContextFilter)

阻塞发送到指定ip对应的集合

参数:

groupContext -

ip -

packet -

channelContextFilter -

返回:

sendToIp

public static void sendToIp(GroupContext groupContext,
                            String ip,
                            Packet packet)

发送到指定ip对应的集合

参数:

groupContext -

ip -

packet -

sendToIp

public static void sendToIp(GroupContext groupContext,
                            String ip,
                            Packet packet,
                            ChannelContextFilter channelContextFilter)

发送到指定ip对应的集合

参数:

groupContext -

ip -

packet -

channelContextFilter -

notifyClusterForIp

public static void notifyClusterForIp(GroupContext groupContext,
                                      String ip,
                                      Packet packet)

在集群环境下，把IP消息通知到集群中的其它机器

参数:

groupContext -

ip -

packet -

sendToId

public static Boolean sendToId(GroupContext groupContext,
                               String channelId,
                               Packet packet)

发消息给指定ChannelContext id

参数:

channelId -

packet -

notifyClusterForId

public static void notifyClusterForId(GroupContext groupContext,
                                      String channelId,
                                      Packet packet)

在集群环境下，把channelId消息通知到集群中的其它机器

参数:

groupContext -

channelId -

packet -

sendToSet

public static void sendToSet(GroupContext groupContext,
                             SetWithLock<ChannelContext> setWithLock,
                             Packet packet,
                             ChannelContextFilter channelContextFilter)

发消息到指定集合

参数:

groupContext -

setWithLock -

packet -

channelContextFilter -

sendToUser

public static Boolean sendToUser(GroupContext groupContext,
                                 String userid,
                                 Packet packet)

发消息给指定用户

参数:

groupContext -

userid -

packet -

sendToToken

public static Boolean sendToToken(GroupContext groupContext,
                                  String token,
                                  Packet packet)

发消息到指定token

参数:

groupContext -

token -

packet -

返回:

notifyClusterForUser

public static void notifyClusterForUser(GroupContext groupContext,
                                        String userid,
                                        Packet packet)

在集群环境下，把userid消息通知到集群中的其它机器

参数:

groupContext -

userid -

packet -

notifyClusterForToken

public static void notifyClusterForToken(GroupContext groupContext,
                                         String token,
                                         Packet packet)

在集群环境下，把token消息通知到集群中的其它机器

参数:

groupContext -

token -

packet -

synSend

public static Packet synSend(ChannelContext channelContext,
                             Packet packet,
                             long timeout)

发送并等待响应.
注意：
1、参数packet的synSeq不为空且大于0（null、等于小于0都不行）
2、对端收到此消息后，需要回一条synSeq一样的消息。业务需要在decode()方法中为packet的synSeq赋值
3、对于同步发送，框架层面并不会帮应用去调用handler.handler(packet, channelContext)方法，应用需要自己去处理响应的消息包，参考：groupContext.getAioHandler().handler(packet, channelContext);

参数:

channelContext -

packet - 业务层必须设置好synSeq字段的值，而且要保证唯一（不能重复）。可以在groupContext范围内用AtomicInteger

timeout -

返回:

unbindGroup

public static void unbindGroup(ChannelContext channelContext)

与所有组解除解绑关系

参数:

channelContext -

unbindGroup

public static void unbindGroup(String group,
                               ChannelContext channelContext)

与指定组解除绑定关系

参数:

group -

channelContext -

unbindUser

public static void unbindUser(ChannelContext channelContext)

解除channelContext绑定的userid

参数:

channelContext -

unbindToken

public static void unbindToken(ChannelContext channelContext)

解除channelContext绑定的token

参数:

channelContext -

unbindUser

public static void unbindUser(GroupContext groupContext,
                              String userid)

解除userid的绑定。一般用于多地登录，踢掉前面登录的场景

参数:

groupContext -

userid -