org.jetlinks.core.server.session

接口 DeviceSessionManager

public interface DeviceSessionManager

设备会话管理器,用于管理所有设备连接会话

从以下版本开始:

1.0.0

作者:

zhouhao

方法概要

限定符和类型	方法和说明
reactor.core.publisher.Flux<DeviceSession>	getAllSession()
long	getCurrentSession(Transport transport) 已过时。
long	getMaximumSession(Transport transport) 已过时。
DeviceSession	getSession(String idOrDeviceId) 根据设备ID或者会话ID获取设备会话
ChildrenDeviceSession	getSession(String deviceId, String childrenId)
boolean	isOutOfMaximumSessionLimit(Transport transport) 已过时。
reactor.core.publisher.Flux<DeviceSession>	onRegister()
reactor.core.publisher.Flux<DeviceSession>	onUnRegister()
DeviceSession	register(DeviceSession session) 注册新到设备会话,如果已经存在相同设备ID到会话,将注销旧的会话.
reactor.core.publisher.Mono<ChildrenDeviceSession>	registerChildren(String deviceId, String childrenDeviceId)
default DeviceSession	replace(DeviceSession oldSession, DeviceSession newSession) 替换session
boolean	sessionIsAlive(String deviceId)
DeviceSession	unregister(String idOrDeviceId) 使用会话ID或者设备ID注销设备会话
reactor.core.publisher.Mono<ChildrenDeviceSession>	unRegisterChildren(String deviceId, String childrenId)

方法详细资料

getSession

@Nullable
DeviceSession getSession(String idOrDeviceId)

根据设备ID或者会话ID获取设备会话

参数:

idOrDeviceId - 设备ID或者会话ID

返回:

设备会话, 不存在则返回null

register

@Nullable
DeviceSession register(DeviceSession session)

注册新到设备会话,如果已经存在相同设备ID到会话,将注销旧的会话.

参数:

session - 新的设备会话

返回:

旧的设备会话, 不存在则返回null

replace

default DeviceSession replace(DeviceSession oldSession,
                              DeviceSession newSession)

替换session

参数:

oldSession - 旧session

newSession - 新session

返回:

新session

从以下版本开始:

1.1.1

unregister

DeviceSession unregister(String idOrDeviceId)

使用会话ID或者设备ID注销设备会话

参数:

idOrDeviceId - 设备ID或者会话ID

返回:

被注销的会话, 不存在则返回null

sessionIsAlive

boolean sessionIsAlive(String deviceId)

getSession

@Nullable
ChildrenDeviceSession getSession(String deviceId,
                                           String childrenId)

registerChildren

reactor.core.publisher.Mono<ChildrenDeviceSession> registerChildren(String deviceId,
                                                                    String childrenDeviceId)

unRegisterChildren

reactor.core.publisher.Mono<ChildrenDeviceSession> unRegisterChildren(String deviceId,
                                                                      String childrenId)

onRegister

reactor.core.publisher.Flux<DeviceSession> onRegister()

onUnRegister

reactor.core.publisher.Flux<DeviceSession> onUnRegister()

getAllSession

reactor.core.publisher.Flux<DeviceSession> getAllSession()

isOutOfMaximumSessionLimit

@Deprecated
boolean isOutOfMaximumSessionLimit(Transport transport)

已过时。

指定的协议是否已经超过了最大连接数量

参数:

transport - 协议

返回:

是否超过

getMaximumSession

@Deprecated
long getMaximumSession(Transport transport)

已过时。

获取指定协议的最大连接数量

参数:

transport - 协议

返回:

最大连接数量

getCurrentSession

@Deprecated
long getCurrentSession(Transport transport)

已过时。

获取指定协议的当前连接数量

参数:

transport - 协议

返回:

当前连接数量