com.kdayun.z1.core.message.sse

类 SseEmitterUtil

java.lang.Object

com.kdayun.z1.core.message.sse.SseEmitterUtil

public class SseEmitterUtil
extends java.lang.Object

嵌套类概要

嵌套类

限定符和类型	类和说明
(专用程序包) static class	SseEmitterUtil.SseMsg

构造器概要

构造器

构造器和说明
SseEmitterUtil()

方法概要

限定符和类型	方法和说明
static void	batchSendMessage(java.lang.String msg) 群发所有人
static void	batchSendMessage(java.lang.String msg, java.util.List<java.lang.String> ids) 群发消息
static org.springframework.web.servlet.mvc.method.annotation.SseEmitter	connect(java.lang.String msgId, java.lang.Integer timeOut) 创建用户连接并返回 SseEmitter
static java.util.List<java.lang.String>	getIds() 获取当前连接信息
static java.util.List<java.lang.String>	getOnlineUserIds() 获取在线的用户id list
static int	getUserCount() 获取当前连接数量
static java.lang.Boolean	live(java.lang.String msgId) 校验id是否还活着
static void	removeUser(KdSseEmitter sseEmitter) 移除用户连接
static void	removeUser(java.lang.String msgId) 移除用户连接
static void	sendMessage(java.lang.String msgId, java.lang.String msgContext) 给指定消息id发送信息
static boolean	sendMessageToToken(java.lang.String tokenId, java.lang.String MSG, java.lang.String msgContext) 给指定的tokenId(session)发送通知消息 一对一
static boolean	sendMessageToUser(java.lang.String userId, java.lang.String MSG, java.lang.String msgContext) 给用户下所有的session都发送通知消息 一对多发送

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

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

构造器详细资料

SseEmitterUtil

public SseEmitterUtil()

方法详细资料

connect

public static org.springframework.web.servlet.mvc.method.annotation.SseEmitter connect(java.lang.String msgId,
                                                                                       java.lang.Integer timeOut)

创建用户连接并返回 SseEmitter

参数:

msgId - 消息ID 字符串格式: [消息值]:[用户id]:[tokenId] mainId:userId:tokenid ; json 格式: {"MSG":"NOTICE_MSG","tokenId":"14e3f7739e4b44829f2dd32efe3e545e"}

timeOut - 超时

返回:

SseEmitter

getOnlineUserIds

public static java.util.List<java.lang.String> getOnlineUserIds()

获取在线的用户id list

参数:

MSG - 消息的唯一ID

返回:

sendMessage

public static void sendMessage(java.lang.String msgId,
                               java.lang.String msgContext)

给指定消息id发送信息

参数:

msgId - 消息唯一ID

messageBase64 - base64编码的消息内容

抛出:

java.lang.Exception

sendMessageToUser

public static boolean sendMessageToUser(java.lang.String userId,
                                        java.lang.String MSG,
                                        java.lang.String msgContext)

给用户下所有的session都发送通知消息 一对多发送

参数:

userId - 用户id

MSG - 通知消息值

msgContext - 通知消息内容

返回:

sendMessageToToken

public static boolean sendMessageToToken(java.lang.String tokenId,
                                         java.lang.String MSG,
                                         java.lang.String msgContext)

给指定的tokenId(session)发送通知消息 一对一

参数:

tokenId - tokenId

MSG - 消息值

msgContext - 通知消息内同

返回:

live

public static java.lang.Boolean live(java.lang.String msgId)

校验id是否还活着

参数:

msgId - 消息id

返回:

true活着,否则false

batchSendMessage

public static void batchSendMessage(java.lang.String msg,
                                    java.util.List<java.lang.String> ids)

群发消息

参数:

wsInfo - 消息

ids - 消息id

batchSendMessage

public static void batchSendMessage(java.lang.String msg)

群发所有人

参数:

msg - 消息

removeUser

public static void removeUser(java.lang.String msgId)

移除用户连接

参数:

msgId - 消息id

removeUser

public static void removeUser(KdSseEmitter sseEmitter)

移除用户连接

参数:

sseEmitter - SseEmitter实例

getIds

public static java.util.List<java.lang.String> getIds()

获取当前连接信息

返回:

消息ids

getUserCount

public static int getUserCount()

获取当前连接数量

返回:

数量