com.kdayun.z1.core.message.sse.controller

类 SseController

java.lang.Object

com.kdayun.z1.core.message.sse.controller.SseController

@RestController
 @RequestMapping(value="/core/sse")
public class SseController
extends java.lang.Object

构造器概要

构造器

构造器和说明
SseController()

方法概要

限定符和类型	方法和说明
RetVo	close(java.lang.String msgId) 关闭连接
org.springframework.web.servlet.mvc.method.annotation.SseEmitter	connect(java.lang.String msgId, java.lang.Integer timeOut) 用于创建连接
RetVo	live(java.lang.String msgId) 判断是否还在线
RetVo	push(java.lang.String message) 推送给所有人
RetVo	pushOne(java.lang.String msgId, java.lang.String message) 发送给单个人

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

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

构造器详细资料

SseController

public SseController()

方法详细资料

connect

@GetMapping(value="/connect/{msgid}/{timeout}")
public org.springframework.web.servlet.mvc.method.annotation.SseEmitter connect(@PathVariable(name="msgid")
                                                                                                                                 java.lang.String msgId,
                                                                                                                                 @PathVariable(name="timeout")
                                                                                                                                 java.lang.Integer timeOut)

用于创建连接

参数:

msgId - 消息ID

timeOut - 消息监听的时间 超过就会释放消息的监听sse对象

返回:

SseEmitter SseEmitter实例

live

@GetMapping(value="/live/{msgid}")
public RetVo live(@PathVariable(name="msgid")
                                                      java.lang.String msgId)

判断是否还在线

参数:

msgId - 消息ID

返回:

RetVo

push

@PostMapping(value="/push")
public RetVo push(@RequestBody
                                               java.lang.String message)
                                        throws java.lang.Exception

推送给所有人

参数:

message - 消息字符串

返回:

RetVo

抛出:

java.lang.Exception

pushOne

@PostMapping(value="/push_one/{msgid}")
public RetVo pushOne(@PathVariable(name="msgid")
                                                              java.lang.String msgId,
                                                              @RequestBody
                                                              java.lang.String message)
                                                       throws java.lang.Exception

发送给单个人

参数:

message - 消息字符串

msgId - 消息ID(可以是用户id,消息唯一id...等唯一值)

返回:

RetVo

抛出:

java.lang.Exception

close

@GetMapping(value="/close/{msgid}")
public RetVo close(@PathVariable(value="msgid")
                                                        java.lang.String msgId)

关闭连接

参数:

msgId - 消息ID

返回:

RetVo