cn.allbs.websocket.util

类 WebSocketUtil

java.lang.Object

cn.allbs.websocket.util.WebSocketUtil

public class WebSocketUtil
extends Object

作者:

ChenQi

构造器概要

构造器

构造器和说明
WebSocketUtil()

方法概要

限定符和类型	方法和说明
static void	addSession(org.springframework.web.socket.WebSocketSession session, String userName) 添加 Session 。
static <T extends Message> void	broadcast(String code, String msg, T data) 广播发送消息给所有在线用户（包括自己）
static <T extends Message> void	broadcast(WebSocketResponseEnum webSocketResponseEnum, T data) 广播发送消息给所有在线用户（包括自己）
static <T extends Message> void	broadcastWithoutSelf(String code, String msg, T data, String userName) 广播发送消息给所有在线用户(除自己)
static <T extends Message> void	broadcastWithoutSelf(WebSocketResponseEnum webSocketResponseEnum, T data, String userName) 广播发送消息给所有在线用户(除自己)
static void	removeSession(org.springframework.web.socket.WebSocketSession session) 移除 Session 。
static <T extends Message> boolean	send(String userName, String code, String msg, T data) 发送消息给指定用户
static <T extends Message> boolean	send(String userName, WebSocketResponseEnum webSocketResponseEnum, T data) 发送消息给指定用户
static <T extends Message> void	send(org.springframework.web.socket.WebSocketSession session, String code, String msg, T data) 发送消息给单个用户的 Session
static <T extends Message> void	send(org.springframework.web.socket.WebSocketSession session, WebSocketResponseEnum webSocketResponseEnum, T data) 发送消息给单个用户的 Session

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

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

构造器详细资料

WebSocketUtil

public WebSocketUtil()

方法详细资料

addSession

public static void addSession(org.springframework.web.socket.WebSocketSession session,
                              String userName)

添加 Session 。在这个方法中，会添加用户和 Session 之间的映射

参数:

session - Session

userName - 用户

removeSession

public static void removeSession(org.springframework.web.socket.WebSocketSession session)

移除 Session 。

参数:

session - Session

broadcast

public static <T extends Message> void broadcast(WebSocketResponseEnum webSocketResponseEnum,
                                                 T data)

广播发送消息给所有在线用户（包括自己）

类型参数:

T - 消息类型

参数:

webSocketResponseEnum - websocket消息枚举

data - 待发送数据

broadcast

public static <T extends Message> void broadcast(String code,
                                                 String msg,
                                                 T data)

广播发送消息给所有在线用户（包括自己）

类型参数:

T - 消息类型

参数:

code - 消息类型

data - 待发送数据

msg - 消息提示

broadcastWithoutSelf

public static <T extends Message> void broadcastWithoutSelf(WebSocketResponseEnum webSocketResponseEnum,
                                                            T data,
                                                            String userName)

广播发送消息给所有在线用户(除自己)

类型参数:

T - 消息类型

参数:

webSocketResponseEnum - websocket发送消息类型枚举

data - 数据

broadcastWithoutSelf

public static <T extends Message> void broadcastWithoutSelf(String code,
                                                            String msg,
                                                            T data,
                                                            String userName)

广播发送消息给所有在线用户(除自己)

类型参数:

T - 消息类型

参数:

code - 消息类型

data - 数据

msg - 消息提示

send

public static <T extends Message> void send(org.springframework.web.socket.WebSocketSession session,
                                            WebSocketResponseEnum webSocketResponseEnum,
                                            T data)

发送消息给单个用户的 Session

类型参数:

T - 消息类型

参数:

session - Session

webSocketResponseEnum - websocket消息枚举

data - 消息体

send

public static <T extends Message> void send(org.springframework.web.socket.WebSocketSession session,
                                            String code,
                                            String msg,
                                            T data)

发送消息给单个用户的 Session

类型参数:

T - 消息类型

参数:

session - Session

code - 消息类型

data - 消息体

msg - 消息提示

send

public static <T extends Message> boolean send(String userName,
                                               String code,
                                               String msg,
                                               T data)

发送消息给指定用户

类型参数:

T - 消息类型

参数:

userName - 指定用户

code - 消息类型

data - 消息体

返回:

发送是否成功你那个

send

public static <T extends Message> boolean send(String userName,
                                               WebSocketResponseEnum webSocketResponseEnum,
                                               T data)

发送消息给指定用户

类型参数:

T - 消息内容

参数:

userName - 用户名

webSocketResponseEnum - 消息枚举

data - 消息内容

返回:

是否发送成功