nl::Weave::WeaveSessionKey

#include <src/lib/core/WeaveFabricState.h>

包含与 Weave 会话密钥相关的信息。

摘要

公共类型
FlagsEnum{
  kFlag_IsLocallyInitiated = 0x01,
  kFlag_IsSharedSession = 0x02,
  kFlag_IsRemoveOnIdle = 0x04,
  kFlag_RecentlyActive = 0x08,
  kFlag_Suspended = 0x10
} 		枚举

公共属性
AuthMode
WeaveAuthMode
在建立会话期间对对等节点进行身份验证的方式。
BoundCon
密钥绑定的连接。
Flags
uint8_t
与会话关联的各种标记。
MaxRcvdMsgId
uint32_t
会话密钥下接收的消息 ID 数上限。
MsgEncKey
Weave 消息加密密钥。
NextMsgId
要在会话密钥下使用的下一个消息 ID。
NodeId
uint64_t
共享会话密钥的节点的 ID。
RcvFlags
WeaveSessionState::ReceiveFlagsType
标记相应键下的跟踪消息。
ReserveCount
uint8_t
保留会话密钥的次数。

公共函数
Clear(void)
void
重置 WeaveSessionKey 对象。
ClearRecentlyActive()
void
表示会话在近期处于非活动状态。
ClearSuspended()
void
Init(void)
void
初始化 WeaveSessionKey 对象。
IsAllocated() const
bool
IsKeySet() const
bool
IsLocallyInitiated() const
bool
IsRecentlyActive() const
bool
IsRemoveOnIdle() const
bool
IsSharedSession() const
bool
IsSuspended() const
bool
MarkRecentlyActive()
void
表示会话在最近处于活跃状态。
MarkSuspended()
void
SetLocallyInitiated(bool val)
void
SetRemoveOnIdle(bool val)
void
设置一个标记，指示是否应在一段时间后自动移除会话。
SetSharedSession(bool val)
void
设置一个标记，指示会话是否为共享会话。

公共类型

旗帜枚举

 FlagsEnum
属性
kFlag_IsLocallyInitiated

会话由本地节点启动。
kFlag_IsRemoveOnIdle

应在空闲时移除会话（仅适用于未绑定到连接的会话）。
kFlag_IsSharedSession

该会话是共享会话。
kFlag_RecentlyActive

会话最近处于活跃状态。
kFlag_Suspended

会话已暂停。

公共属性

身份验证模式

WeaveAuthMode AuthMode

在建立会话期间对对等节点进行身份验证的方式。

绑定

WeaveConnection * BoundCon

密钥绑定的连接。

标志

uint8_t Flags

与会话关联的各种标记。

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

会话密钥下接收的消息 ID 数上限。

MS zh 密钥

WeaveMsgEncryptionKey MsgEncKey

Weave 消息加密密钥。

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

要在会话密钥下使用的下一个消息 ID。

NodeId

uint64_t NodeId

共享会话密钥的节点的 ID。

Rcv 标志

WeaveSessionState::ReceiveFlagsType RcvFlags

标记相应键下的跟踪消息。

预订数

uint8_t ReserveCount

保留会话密钥的次数。

公共函数

清除

void Clear(
  void
)

重置 WeaveSessionKey 对象。

清除近期使用记录

void ClearRecentlyActive()

表示会话在近期处于非活动状态。

清除已暂停

void ClearSuspended()

Init

void Init(
  void
)

初始化 WeaveSessionKey 对象。

已分配

bool IsAllocated() const

详细信息
返回值
如果分配了 WeaveSessionKey 对象，则为 True。

密钥集

bool IsKeySet() const

详细信息
返回值
如果在 WeaveSessionKey 对象中设置了加密密钥值，则返回 True。

本地发起的

bool IsLocallyInitiated() const

详细信息
返回值
如果会话是由本地节点发起的，则为 true。

最近使用过

bool IsRecentlyActive() const

详细信息
返回值
如果会话在近期处于活跃状态，则为 true。

IsRemoveOnIdle

bool IsRemoveOnIdle() const

详细信息
返回值
如果会话被标记为在闲置一段时间后自动移除，则为 true。

IsSharedSession

bool IsSharedSession() const

已暂停

bool IsSuspended() const

标记为近期有效

void MarkRecentlyActive()

表示会话在最近处于活跃状态。

标记为暂停

void MarkSuspended()

SetLocallyInitiated 已启动

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

设置一个标记，指示是否应在一段时间后自动移除会话。

详细信息
参数
[in] val
要将 kFlag_IsRemoveOnIdle 标志设置为的值。

SetSharedSession

void SetSharedSession(
  bool val
)

设置一个标记，指示会话是否为共享会话。

详细信息
参数
[in] val
要将 kFlag_IsSharedSession 标志设置为的值。