本頁面由 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 物件，則為「是」。

IsKeySet

bool IsKeySet() const

詳細說明
傳回	如果已在 WeaveSessionKey 物件中設定加密金鑰值，則為「true」。

IsLocallyInitiated

bool IsLocallyInitiated() const

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

IsRecentlyActive

bool IsRecentlyActive() const

詳細說明
傳回	如果最近曾經啟用工作階段，則為「是」。

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
)

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

詳細說明

參數

[in] val

將 kFlag_IsRemoveOnIdle 標記的值設為該值。

SetSharedSession

void SetSharedSession(
  bool val
)

設定標記，指出工作階段是否為共用工作階段。

詳細說明

參數

[in] val

要將 kFlag_IsSharedSession 標記的值設為。