com.github.sseserver

接口 LocalConnectionService

所有已知实现类:

LocalConnectionServiceImpl

public interface LocalConnectionService

单机长连接(非分布式) 1. 如果用nginx代理, 要加下面的配置 # 长连接配置 proxy_buffering off; proxy_read_timeout 7200s; proxy_pass http://xx.xx.xx.xx:xxx; proxy_http_version 1.1; #nginx默认是http1.0, 改为1.1 支持长连接, 和后端保持长连接,复用,防止出现文件句柄打开数量过多的错误 proxy_set_header Connection ""; # 去掉Connection的close字段

作者:

hao 2021年12月7日19:27:41

方法概要

限定符和类型	方法和说明
<ACCESS_USER extends AccessUser & AccessToken> void	addConnectListener(Consumer<SseEmitter<ACCESS_USER>> consumer)
<ACCESS_USER extends AccessUser & AccessToken> void	addConnectListener(String accessToken, Consumer<SseEmitter<ACCESS_USER>> consumer)
<ACCESS_USER extends AccessUser & AccessToken> void	addConnectListener(String accessToken, String channel, Consumer<SseEmitter<ACCESS_USER>> consumer)
<ACCESS_USER extends AccessUser & AccessToken> void	addDisConnectListener(Consumer<SseEmitter<ACCESS_USER>> consumer)
<ACCESS_USER extends AccessUser & AccessToken> void	addDisConnectListener(String accessToken, Consumer<SseEmitter<ACCESS_USER>> consumer)
<ACCESS_USER extends AccessUser & AccessToken> SseEmitter<ACCESS_USER>	connect(ACCESS_USER accessUser, Long keepaliveTime) 创建用户连接并返回 SseEmitter
<ACCESS_USER extends AccessUser & AccessToken> SseEmitter<ACCESS_USER>	connect(ACCESS_USER accessUser, Long keepaliveTime, Map<String,Object> attributeMap)
<ACCESS_USER extends AccessUser & AccessToken> List<SseEmitter<ACCESS_USER>>	disconnectByAccessToken(String accessToken)
<ACCESS_USER extends AccessUser & AccessToken> SseEmitter<ACCESS_USER>	disconnectByConnectionId(Long connectionId)
<ACCESS_USER extends AccessUser & AccessToken> List<SseEmitter<ACCESS_USER>>	disconnectByUserId(Object userId)
int	getAccessTokenCount() 获取当前登录端数量
List<String>	getAccessTokens()
String	getBeanName() 可以在spring里多实例 （例如：HR系统的用户链接，猎头系统的用户链接）
List<String>	getChannels()
<ACCESS_USER extends AccessUser & AccessToken> Collection<SseEmitter<ACCESS_USER>>	getConnectionAll()
<ACCESS_USER extends AccessUser & AccessToken> Collection<SseEmitter<ACCESS_USER>>	getConnectionByAccessToken(String accessToken)
<ACCESS_USER extends AccessUser & AccessToken> Collection<SseEmitter<ACCESS_USER>>	getConnectionByChannel(String channel)
<ACCESS_USER extends AccessUser & AccessToken> Collection<SseEmitter<ACCESS_USER>>	getConnectionByCustomerId(Object userId)
<ACCESS_USER extends AccessUser & AccessToken> SseEmitter<ACCESS_USER>	getConnectionById(Long connectionId)
<ACCESS_USER extends AccessUser & AccessToken> Collection<SseEmitter<ACCESS_USER>>	getConnectionByUserId(Object userId)
int	getConnectionCount() 获取当前连接数量
List<Long>	getConnectionIds()
List<String>	getCustomerIds()
int	getUserCount() 获取当前用户数量
List<String>	getUserIds()
int	send(Collection<SseEmitter> sseEmitterList, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
int	sendAll(org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
int	sendByAccessToken(Collection<String> accessTokens, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
default int	sendByAccessToken(String accessToken, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
int	sendByChannel(Collection<String> channels, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
default int	sendByChannel(String channel, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
int	sendByConnectionId(Collection<Long> connectionIds, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
default int	sendByConnectionId(Long connectionId, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
int	sendByCustomerId(Collection<?> customerIds, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
default int	sendByCustomerId(Object customerId, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
int	sendByUserId(Collection<?> userIds, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)
default int	sendByUserId(Object userId, org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

方法详细资料

connect

<ACCESS_USER extends AccessUser & AccessToken> SseEmitter<ACCESS_USER> connect(ACCESS_USER accessUser,
                                                                               Long keepaliveTime)

创建用户连接并返回 SseEmitter

参数:

accessUser - 用户令牌

keepaliveTime - 链接最大保持时间 ，0表示不过期。默认30秒，超过时间未完成会抛出异常：AsyncRequestTimeoutException

返回:

SseEmitter

connect

<ACCESS_USER extends AccessUser & AccessToken> SseEmitter<ACCESS_USER> connect(ACCESS_USER accessUser,
                                                                               Long keepaliveTime,
                                                                               Map<String,Object> attributeMap)

disconnectByUserId

<ACCESS_USER extends AccessUser & AccessToken> List<SseEmitter<ACCESS_USER>> disconnectByUserId(Object userId)

disconnectByAccessToken

<ACCESS_USER extends AccessUser & AccessToken> List<SseEmitter<ACCESS_USER>> disconnectByAccessToken(String accessToken)

disconnectByConnectionId

<ACCESS_USER extends AccessUser & AccessToken> SseEmitter<ACCESS_USER> disconnectByConnectionId(Long connectionId)

addConnectListener

<ACCESS_USER extends AccessUser & AccessToken> void addConnectListener(String accessToken,
                                                                       String channel,
                                                                       Consumer<SseEmitter<ACCESS_USER>> consumer)

addConnectListener

<ACCESS_USER extends AccessUser & AccessToken> void addConnectListener(String accessToken,
                                                                       Consumer<SseEmitter<ACCESS_USER>> consumer)

addConnectListener

<ACCESS_USER extends AccessUser & AccessToken> void addConnectListener(Consumer<SseEmitter<ACCESS_USER>> consumer)

addDisConnectListener

<ACCESS_USER extends AccessUser & AccessToken> void addDisConnectListener(Consumer<SseEmitter<ACCESS_USER>> consumer)

addDisConnectListener

<ACCESS_USER extends AccessUser & AccessToken> void addDisConnectListener(String accessToken,
                                                                          Consumer<SseEmitter<ACCESS_USER>> consumer)

getConnectionById

<ACCESS_USER extends AccessUser & AccessToken> SseEmitter<ACCESS_USER> getConnectionById(Long connectionId)

getConnectionByChannel

<ACCESS_USER extends AccessUser & AccessToken> Collection<SseEmitter<ACCESS_USER>> getConnectionByChannel(String channel)

getConnectionByAccessToken

<ACCESS_USER extends AccessUser & AccessToken> Collection<SseEmitter<ACCESS_USER>> getConnectionByAccessToken(String accessToken)

getConnectionByUserId

<ACCESS_USER extends AccessUser & AccessToken> Collection<SseEmitter<ACCESS_USER>> getConnectionByUserId(Object userId)

getConnectionByCustomerId

<ACCESS_USER extends AccessUser & AccessToken> Collection<SseEmitter<ACCESS_USER>> getConnectionByCustomerId(Object userId)

getConnectionAll

<ACCESS_USER extends AccessUser & AccessToken> Collection<SseEmitter<ACCESS_USER>> getConnectionAll()

send

int send(Collection<SseEmitter> sseEmitterList,
         org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendAll

int sendAll(org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendByConnectionId

int sendByConnectionId(Collection<Long> connectionIds,
                       org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendByConnectionId

default int sendByConnectionId(Long connectionId,
                               org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendByChannel

int sendByChannel(Collection<String> channels,
                  org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendByChannel

default int sendByChannel(String channel,
                          org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendByAccessToken

int sendByAccessToken(Collection<String> accessTokens,
                      org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendByAccessToken

default int sendByAccessToken(String accessToken,
                              org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendByUserId

int sendByUserId(Collection<?> userIds,
                 org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendByUserId

default int sendByUserId(Object userId,
                         org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendByCustomerId

int sendByCustomerId(Collection<?> customerIds,
                     org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

sendByCustomerId

default int sendByCustomerId(Object customerId,
                             org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder message)

getConnectionIds

List<Long> getConnectionIds()

getAccessTokens

List<String> getAccessTokens()

getUserIds

List<String> getUserIds()

getCustomerIds

List<String> getCustomerIds()

getChannels

List<String> getChannels()

getAccessTokenCount

int getAccessTokenCount()

获取当前登录端数量

getUserCount

int getUserCount()

获取当前用户数量

getConnectionCount

int getConnectionCount()

获取当前连接数量

getBeanName

String getBeanName()

可以在spring里多实例 （例如：HR系统的用户链接，猎头系统的用户链接）

返回:

spring的bean名称