DeviceSession (JetLinks Core 1.1.9 API)

所有已知子接口:

PersistentSession

所有已知实现类:

ChildrenDeviceSession, KeepOnlineSession, LostDeviceSession
```
public interface DeviceSession
```
设备会话,通常对应一个设备连接

从以下版本开始:

1.0.0

作者:

zhouhao

另请参阅:

ChildrenDeviceSession, KeepOnlineSession

方法概要

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

- 方法详细资料
  - getId
```
String getId()
```
    返回:
    
    会话ID
  - getDeviceId
```
String getDeviceId()
```
    返回:
    
    设备ID
  - getOperator
```
@Nullable
DeviceOperator getOperator()
```
    获取设备操作对象,在类似TCP首次请求的场景下,返回值可能为null. 可以通过判断此返回值是否为null,来处理首次连接的情况。
    
    返回:
    
    void
  - lastPingTime
```
long lastPingTime()
```
    返回:
    
    最近心跳时间
  - connectTime
```
long connectTime()
```
    返回:
    
    创建时间
  - send
```
reactor.core.publisher.Mono<Boolean> send(EncodedMessage encodedMessage)
```
    发送消息给会话
    
    参数:
    
    encodedMessage - 消息
    
    返回:
    
    是否成功
    
    另请参阅:
    
    MqttMessage
  - getTransport
```
Transport getTransport()
```
    传输协议,比如MQTT,TCP等
    
    返回:
    
    void
  - close
```
void close()
```
    关闭session
  - ping
```
void ping()
```
    心跳
    
    另请参阅:
    
    keepAlive()
  - isAlive
```
boolean isAlive()
```
    返回:
    
    会话是否存活
  - onClose
```
void onClose(Runnable call)
```
    设置close回调
    
    参数:
    
    call - 回调
  - getServerId
```
default Optional<String> getServerId()
```
    返回:
    
    会话连接的服务ID
  - getClientAddress
```
default Optional<InetSocketAddress> getClientAddress()
```
    返回:
    
    客户端地址
  - keepAlive
```
default void keepAlive()
```
  - setKeepAliveTimeout
```
default void setKeepAliveTimeout(java.time.Duration timeout)
```
    设置心跳超时时间
    
    参数:
    
    timeout - 心跳超时时间
  - getKeepAliveTimeout
```
default java.time.Duration getKeepAliveTimeout()
```
  - isWrapFrom
```
default boolean isWrapFrom(Class<?> type)
```
    判断会话是否包装自指定的类型,在某些场景下,可能会对会话进行包装
    
    参数:
    
    type - 类型
    
    返回:
    
    是否包装自指定的类型
  - unwrap
```
default <T extends DeviceSession> T unwrap(Class<T> type)
```
    展开为指定对会话类型,通过此方法拿到最原始对会话对象进行操作.如果类型不一致可能会抛出ClassCastException
    
    类型参数:
    
    T - 类型泛型
    
    参数:
    
    type - 类型
    
    返回:
    
    指定类型对会话

接口 DeviceSession

方法概要

方法详细资料

getId

getDeviceId

getOperator

lastPingTime

connectTime

send

getTransport

close

ping

isAlive

onClose

getServerId

getClientAddress

keepAlive

setKeepAliveTimeout

getKeepAliveTimeout

isWrapFrom

unwrap