cn.herodotus.engine.message.websocket.processor

类 WebSocketMessageSender

java.lang.Object

cn.herodotus.engine.message.websocket.processor.WebSocketMessageSender

public class WebSocketMessageSender
extends Object

Description: Web Socket 服务端消息发送

作者:

: gengwei.zheng

Date:

: 2021/10/24 18:47

构造器概要

构造器

构造器和说明
WebSocketMessageSender()

方法概要

限定符和类型	方法和说明
<T> void	sendNoticeToAll(T payload) 广播 WebSocket 信息
<T> void	sendOnlineToAll(T payload) 广播 WebSocket 信息
void	setSimpMessagingTemplate(org.springframework.messaging.simp.SimpMessagingTemplate simpMessagingTemplate)
void	setSimpUserRegistry(org.springframework.messaging.simp.user.SimpUserRegistry simpUserRegistry)
<T> void	toAll(String channel, T payload)
<T> void	toUser(WebSocketMessage<T> webSocketMessage) 发送给指定用户信息。

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

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

构造器详细资料

WebSocketMessageSender

public WebSocketMessageSender()

方法详细资料

setSimpMessagingTemplate

public void setSimpMessagingTemplate(org.springframework.messaging.simp.SimpMessagingTemplate simpMessagingTemplate)

setSimpUserRegistry

public void setSimpUserRegistry(org.springframework.messaging.simp.user.SimpUserRegistry simpUserRegistry)

toUser

public <T> void toUser(WebSocketMessage<T> webSocketMessage)
                throws cn.herodotus.engine.message.core.exception.IllegalChannelException,
                       cn.herodotus.engine.message.core.exception.PrincipalNotFoundException

发送给指定用户信息。

类型参数:

T - 指定 payload 类型

参数:

webSocketMessage - 发送内容参数实体 WebSocketMessage

抛出:

cn.herodotus.engine.message.core.exception.IllegalChannelException - Web Socket 通道设置错误

cn.herodotus.engine.message.core.exception.PrincipalNotFoundException - 该服务中无法找到与 identity 对应的用户 Principal

toAll

public <T> void toAll(String channel,
                      T payload)

sendNoticeToAll

public <T> void sendNoticeToAll(T payload)

广播 WebSocket 信息

类型参数:

T - payload 类型

参数:

payload - 发送的内容

sendOnlineToAll

public <T> void sendOnlineToAll(T payload)

广播 WebSocket 信息

类型参数:

T - payload 类型

参数:

payload - 发送的内容