本頁面由 Cloud Translation API 翻譯而成。

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`	`WeaveConnection *` 金鑰繫結的連線。
`Flags`	`uint8_t` 與工作階段相關聯的各種旗標。
`MaxRcvdMsgId`	`uint32_t` 工作階段金鑰下方接收的訊息 ID 上限。
`MsgEncKey`	`WeaveMsgEncryptionKey` Weave 訊息加密金鑰。
`NextMsgId`	`MonotonicallyIncreasingCounter` 下一個訊息 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

與工作階段相關聯的各種旗標。

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

工作階段金鑰下方接收的訊息 ID 上限。

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

Weave 訊息加密金鑰。

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

下一個訊息 ID 會顯示在工作階段金鑰底下。

NodeId

uint64_t NodeId

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

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

標記金鑰下收到的追蹤訊息。

ReserveCount

uint8_t ReserveCount

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

公開函式

清除

void Clear(
  void
)

重設 WeaveSessionKey 物件。

ClearRecentlyActive

void ClearRecentlyActive()

將該工作階段在過去稱為「沒有」活動。

ClearSuspended

void ClearSuspended()

Init

void Init(
  void
)

初始化 WeaveSessionKey 物件。

IsAllocated

bool IsAllocated() const

詳細資料
傳回	如果已分配 WeaveSessionKey 物件，則為 True。

IsKeySet

bool IsKeySet() const

詳細資料
傳回	如果 WeaveSessionKey 物件中已設定加密金鑰值，則傳回 true。

IsLocallyInitiated

bool IsLocallyInitiated() const

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

IsRecentlyActive

bool IsRecentlyActive() const

詳細資料
傳回	如果工作階段最近才啟用，則為 True。

IsRemoveOnIdle

bool IsRemoveOnIdle() const

詳細資料
傳回	如果工作階段在閒置一段時間後自動移除，則為「是」。

IsSharedSession

bool IsSharedSession() const

IsSuspended

bool IsSuspended() const

MarkRecentlyActive

void MarkRecentlyActive()

將工作階段在過去的對話狀態發出。

MarkSuspended

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 標記設為的值，