nl:: Weave:: WeaveSessionKey
#include <src/lib/core/WeaveFabricState.h>
包含 Weave 会话密钥的相关信息。
摘要
公共类型 |
|
---|---|
FlagsEnum{
|
枚举 |
公共属性 |
|
---|---|
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
FlagsEnum
属性 | |
---|---|
kFlag_IsLocallyInitiated
|
会话由本地节点发起。 |
kFlag_IsRemoveOnIdle
|
该会话在空闲时应被移除(仅适用于未绑定到连接的会话)。 |
kFlag_IsSharedSession
|
此会话为共享会话。 |
kFlag_RecentlyActive
|
该会话最近处于活动状态。 |
kFlag_Suspended
|
此会话已暂停。 |
公共属性
AuthMode
WeaveAuthMode AuthMode
在会话建立期间对对等节点进行身份验证的方式。
标志
uint8_t Flags
与会话关联的各种标记。
MaxRcvdMsgId
uint32_t MaxRcvdMsgId
通过会话密钥接收的最大消息 ID。
NodeId
uint64_t NodeId
共享会话密钥的节点的 ID。
RcvFlags
WeaveSessionState::ReceiveFlagsType RcvFlags
标记在键下收到的跟踪消息。
ReserveCount
uint8_t ReserveCount
预留会话密钥的次数。
公共函数
ClearRecentlyActive
void ClearRecentlyActive()
表示会话最近没有处于活跃状态。
ClearSuspended
void ClearSuspended()
IsLocallyInitiated
bool IsLocallyInitiated() const
具体说明 | |
---|---|
返回值 |
如果会话由本地节点发起,则为 true。
|
IsRecentlyActive
bool IsRecentlyActive() const
具体说明 | |
---|---|
返回值 |
如果会话在最近处于活跃状态,则为 true。
|
IsRemoveOnIdle
bool IsRemoveOnIdle() const
具体说明 | |
---|---|
返回值 |
如果会话被标记为在闲置一段时间后自动移除,则为 true。
|
IsSharedSession
bool IsSharedSession() const
IsSuspended
bool IsSuspended() const
MarkRecentlyActive
void MarkRecentlyActive()
表示会话在最近处于活跃状态。
MarkSuspended
void MarkSuspended()
SetLocallyInitiated
void SetLocallyInitiated( bool val )
SetRemoveOnIdle
void SetRemoveOnIdle( bool val )
设置一个标记,指示是否应在一段时间的空闲时间后自动移除会话。
具体说明 | |||
---|---|---|---|
参数 |
|
SetSharedSession
void SetSharedSession( bool val )
设置标记,指示会话是否为共享会话。
具体说明 | |||
---|---|---|---|
参数 |
|