透過集合功能整理內容 你可以依據偏好儲存及分類內容。

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

 FlagsEnum
屬性
kFlag_IsLocallyInitiated

工作階段由本機節點啟動。

kFlag_IsRemoveOnIdle

工作階段在閒置時就會移除 (僅適用於未連結至連線的工作階段)。

kFlag_IsSharedSession

這個工作階段是共用的工作階段。

kFlag_RecentlyActive

這個工作階段最近才剛上線。

kFlag_Suspended

這個工作階段已遭停權。

公開屬性

AuthMode

WeaveAuthMode AuthMode

建立工作階段期間對對等互連節點進行驗證的方式。

BoundCon

WeaveConnection * BoundCon

金鑰繫結的連線。

旗標

uint8_t Flags

與工作階段相關的多種標記。

最高成效角色

uint32_t MaxRcvdMsgId

在工作階段金鑰之下接收的郵件 ID 數量上限。

MGgEncKey

WeaveMsgEncryptionKey MsgEncKey

Weave 訊息加密金鑰。

NextMsg 編號

MonotonicallyIncreasingCounter NextMsgId

下一個工作階段 ID 用於工作階段金鑰。

節點編號

uint64_t NodeId

與工作階段金鑰共用的節點 ID。

休旅車旗

WeaveSessionState::ReceiveFlagsType RcvFlags

標記在金鑰下追蹤的訊息。

保留數

uint8_t ReserveCount

工作階段金鑰的保留次數。

公開函式

清除

void Clear(
  void
)

重設 WeaveSessionKey 物件。

清除近期活動

void ClearRecentlyActive()

將工作階段設為「非」過去有效。

清除已停權

void ClearSuspended()

Init

void Init(
  void
)

初始化 WeaveSessionKey 物件。

已分配

bool IsAllocated() const 

詳細資料
傳回
如果分配了 WeaveSessionKey 物件,則值為 True。

IsKeySet

bool IsKeySet() const 

詳細資料
傳回
如果已在 WeaveSessionKey 物件中設定加密金鑰值,則為 True。

本地啟動

bool IsLocallyInitiated() const 

詳細資料
傳回
如果工作階段是由本機節點啟動,則傳回 true。

最近使用中

bool IsRecentlyActive() const 

詳細資料
傳回
如果工作階段在最近執行過,則傳回 true。

移除 ID

bool IsRemoveOnIdle() const 

詳細資料
傳回
如果工作階段因閒置而自動移除,將設為 True。

共用工作階段

bool IsSharedSession() const 

已停權

bool IsSuspended() const 

最近使用

void MarkRecentlyActive()

讓工作階段變成最近進行的活動。

標示為暫停

void MarkSuspended()

SetLocally

void SetLocallyInitiated(
  bool val
)

SetSetOnIdle

void SetRemoveOnIdle(
  bool val
)

設定標記,指定是否要在閒置一段時間後自動移除工作階段。

詳細資料
參數
[in] val
要設定 kFlag_IsRemoveOnIdle 旗標的值。

已設定共用工作階段

void SetSharedSession(
  bool val
)

設定用來指出工作階段是否為共用工作階段的旗標。

詳細資料
參數
[in] val
用來設定 kFlag_IsSharedSession 值的數值。