Package cn.herodotus.engine.message.websocket.definition

Interface WebSocketMessageSender

All Known Implementing Classes:

AbstractWebSocketMessageSender, MultipleInstanceMessageSender, SingleInstanceMessageSender

public interface WebSocketMessageSender

Description: WebSocket 消息发送操作定义

Author:

: gengwei.zheng

Date:

: 2023/10/26 23:32

Method Summary

Modifier and Type	Method	Description
default void	announcement(Object payload)	发送公告信息
default void	online(Object payload)	发送实时在线用户统计信息
void	toAll(String destination, Object payload)	发送 WebSocket 广播消息。发送全员信息
default void	toUser(cn.herodotus.engine.message.core.definition.domain.WebSocketMessage webSocketMessage)	送 WebSocket 点对点消息。发送信息给指定用户
void	toUser(String user, String destination, Object payload)	发送 WebSocket 点对点消息。发送信息给指定用户

Method Details

toUser

void toUser(String user,
 String destination,
 Object payload)

发送 WebSocket 点对点消息。发送信息给指定用户

Parameters:

user - 用户唯一标识

destination - 消息通道

payload - 消息内容

toUser

default void toUser(cn.herodotus.engine.message.core.definition.domain.WebSocketMessage webSocketMessage)

送 WebSocket 点对点消息。发送信息给指定用户

Parameters:

webSocketMessage - 消息实体 WebSocketMessage

toAll

void toAll(String destination,
 Object payload)

发送 WebSocket 广播消息。发送全员信息

Parameters:

destination - 消息通道

payload - 消息内容

announcement

default void announcement(Object payload)

发送公告信息

Parameters:

payload - 消息内容

online

default void online(Object payload)

发送实时在线用户统计信息

Parameters:

payload - 消息内容