cn.stylefeng.roses.kernel.socket.api

接口 SocketOperatorApi

public interface SocketOperatorApi

Socket通用操作类

可通过该类直接发送消息，每一个Socket实现的子模块必须实现该接口，以提供统一的操作API

作者:

majianguo

方法概要

限定符和类型	方法和说明
void	closeSocketBySocketId(String socketId) 根据会话id关闭会话
void	msgTypeCallback(String msgType, SocketMsgCallbackInterface callbackInterface) 监听指定类型消息 1.该方法每调用一次即注册一个监听,同一个消息类型多次调用只有最后一次生效
void	sendMsgOfAllUserSession(String msgType, Object msg) 发送消息到所有会话
void	sendMsgOfUserSession(String msgType, String userId, Object msg) 发送消息到指定用户的所有会话 如果用户同一个消息类型建立了多个会话，则统一全部发送
void	sendMsgOfUserSessionBySessionId(String msgType, String sessionId, Object msg) 发送消息到指定会话

方法详细资料

sendMsgOfUserSessionBySessionId

void sendMsgOfUserSessionBySessionId(String msgType,
                                     String sessionId,
                                     Object msg)
                              throws SocketException

发送消息到指定会话

参数:

msgType - 消息类型可参考cn.stylefeng.roses.kernel.socket.api.enums枚举类

sessionId - 会话ID

msg - 消息体

抛出:

SocketException

sendMsgOfUserSession

void sendMsgOfUserSession(String msgType,
                          String userId,
                          Object msg)
                   throws SocketException

发送消息到指定用户的所有会话

如果用户同一个消息类型建立了多个会话，则统一全部发送

参数:

msgType - 消息类型可参考cn.stylefeng.roses.kernel.socket.api.enums枚举类

userId - 用户ID

msg - 消息体

抛出:

SocketException

sendMsgOfAllUserSession

void sendMsgOfAllUserSession(String msgType,
                             Object msg)

发送消息到所有会话

参数:

msgType - 消息类型可参考cn.stylefeng.roses.kernel.socket.api.enums枚举类

msg - 消息体

closeSocketBySocketId

void closeSocketBySocketId(String socketId)

根据会话id关闭会话

参数:

socketId - 会话id

msgTypeCallback

void msgTypeCallback(String msgType,
                     SocketMsgCallbackInterface callbackInterface)

监听指定类型消息

1.该方法每调用一次即注册一个监听,同一个消息类型多次调用只有最后一次生效

参数:

msgType - 消息类型可参考cn.stylefeng.roses.kernel.socket.api.enums枚举类

callbackInterface - 消息监听器