org.jetlinks.core.server.session

类 KeepOnlineSession

java.lang.Object

org.jetlinks.core.server.session.KeepOnlineSession

所有已实现的接口:

DeviceSession, PersistentSession, ReplaceableDeviceSession

public class KeepOnlineSession
extends Object
implements DeviceSession, ReplaceableDeviceSession, PersistentSession

构造器概要

构造器

构造器和说明
KeepOnlineSession(DeviceSession parent, java.time.Duration keepAliveTimeOut)

方法概要

限定符和类型	方法和说明
void	close() 关闭session
long	connectTime()
Optional<InetSocketAddress>	getClientAddress()
String	getDeviceId()
String	getId()
java.time.Duration	getKeepAliveTimeout()
DeviceOperator	getOperator() 获取设备操作对象,在类似TCP首次请求的场景下,返回值可能为null.
String	getProvider()
Optional<String>	getServerId()
Transport	getTransport() 传输协议,比如MQTT,TCP等
boolean	isAlive()
boolean	isWrapFrom(Class<?> type) 判断会话是否包装自指定的类型,在某些场景下,可能会对会话进行包装
long	lastPingTime()
void	onClose(Runnable call) 设置close回调
void	ping() 心跳
void	replaceWith(DeviceSession session)
reactor.core.publisher.Mono<Boolean>	send(EncodedMessage encodedMessage) 发送消息给会话
void	setKeepAliveTimeout(java.time.Duration timeout) 设置心跳超时时间
<T extends DeviceSession> T	unwrap(Class<T> type) 展开为指定对会话类型,通过此方法拿到最原始对会话对象进行操作.如果类型不一致可能会抛出ClassCastException

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

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

从接口继承的方法 org.jetlinks.core.server.session.DeviceSession

keepAlive

构造器详细资料

KeepOnlineSession

public KeepOnlineSession(DeviceSession parent,
                         java.time.Duration keepAliveTimeOut)

方法详细资料

getId

public String getId()

指定者:

getId 在接口中 DeviceSession

返回:

会话ID

getDeviceId

public String getDeviceId()

指定者:

getDeviceId 在接口中 DeviceSession

返回:

设备ID

getOperator

@Nullable
public DeviceOperator getOperator()

从接口复制的说明: DeviceSession

获取设备操作对象,在类似TCP首次请求的场景下,返回值可能为null. 可以通过判断此返回值是否为null,来处理首次连接的情况。

指定者:

getOperator 在接口中 DeviceSession

返回:

void

lastPingTime

public long lastPingTime()

指定者:

lastPingTime 在接口中 DeviceSession

返回:

最近心跳时间

connectTime

public long connectTime()

指定者:

connectTime 在接口中 DeviceSession

返回:

创建时间

send

public reactor.core.publisher.Mono<Boolean> send(EncodedMessage encodedMessage)

从接口复制的说明: DeviceSession

发送消息给会话

指定者:

send 在接口中 DeviceSession

参数:

encodedMessage - 消息

返回:

是否成功

另请参阅:

MqttMessage

getTransport

public Transport getTransport()

从接口复制的说明: DeviceSession

传输协议,比如MQTT,TCP等

指定者:

getTransport 在接口中 DeviceSession

返回:

void

close

public void close()

从接口复制的说明: DeviceSession

关闭session

指定者:

close 在接口中 DeviceSession

ping

public void ping()

从接口复制的说明: DeviceSession

心跳

指定者:

ping 在接口中 DeviceSession

另请参阅:

DeviceSession.keepAlive()

isAlive

public boolean isAlive()

指定者:

isAlive 在接口中 DeviceSession

返回:

会话是否存活

onClose

public void onClose(Runnable call)

从接口复制的说明: DeviceSession

设置close回调

指定者:

onClose 在接口中 DeviceSession

参数:

call - 回调

getServerId

public Optional<String> getServerId()

指定者:

getServerId 在接口中 DeviceSession

返回:

会话连接的服务ID

getClientAddress

public Optional<InetSocketAddress> getClientAddress()

指定者:

getClientAddress 在接口中 DeviceSession

返回:

客户端地址

setKeepAliveTimeout

public void setKeepAliveTimeout(java.time.Duration timeout)

从接口复制的说明: DeviceSession

设置心跳超时时间

指定者:

setKeepAliveTimeout 在接口中 DeviceSession

参数:

timeout - 心跳超时时间

getKeepAliveTimeout

public java.time.Duration getKeepAliveTimeout()

指定者:

getKeepAliveTimeout 在接口中 DeviceSession

isWrapFrom

public boolean isWrapFrom(Class<?> type)

从接口复制的说明: DeviceSession

判断会话是否包装自指定的类型,在某些场景下,可能会对会话进行包装

指定者:

isWrapFrom 在接口中 DeviceSession

参数:

type - 类型

返回:

是否包装自指定的类型

unwrap

public <T extends DeviceSession> T unwrap(Class<T> type)

从接口复制的说明: DeviceSession

展开为指定对会话类型,通过此方法拿到最原始对会话对象进行操作.如果类型不一致可能会抛出ClassCastException

指定者:

unwrap 在接口中 DeviceSession

类型参数:

T - 类型泛型

参数:

type - 类型

返回:

指定类型对会话

replaceWith

public void replaceWith(DeviceSession session)

指定者:

replaceWith 在接口中 ReplaceableDeviceSession

getProvider

public String getProvider()

指定者:

getProvider 在接口中 PersistentSession

返回:

会话提供者