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

nl::Weave::WeaveFabricState

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

摘要

建構函式和解構函式
`WeaveFabricState(void)`

公開類型
`PeerIndexType`	typedef `uint8_t`
`SessionEndCbFunct)(uint16_t keyId, uint64_t peerNodeId, void *context)`	typedef `void(*`
`State`	列舉

公開屬性
`AutoCreateKeys`	`bool`
`DebugFabricId`	`uint64_t`
`DefaultSubnet`	`uint16_t`
`FabricId`	`uint64_t`
`GroupKeyStore`	`nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase *`
`ListenIPv4Addr`	`IPAddress`
`ListenIPv6Addr`	`IPAddress`
`LocalNodeId`	`uint64_t`
`LogKeys`	`bool`
`MaxUnencUDPMsgIdRcvd[WEAVE_CONFIG_MAX_PEER_NODES]`	`uint32_t`
`MessageLayer`	`WeaveMessageLayer *`
`MostRecentlyUsedIndexes[WEAVE_CONFIG_MAX_PEER_NODES]`	`PeerIndexType`
`NodeId[WEAVE_CONFIG_MAX_PEER_NODES]`	`uint64_t`
`PairingCode`	`const char *`
`State`	`uint8_t`
`UnencRcvFlags[WEAVE_CONFIG_MAX_PEER_NODES]`	`WeaveSessionState::ReceiveFlagsType`
`UseTestKey`	`bool`

公開函式
`AddSharedSessionEndNode(uint64_t endNodeId, uint64_t terminatingNodeId, uint16_t keyId)`	`WEAVE_ERROR`
`AddSharedSessionEndNode(WeaveSessionKey *sessionKey, uint64_t endNodeId)`	`WEAVE_ERROR` 這個方法會將新的結束節點新增至共用端點記錄。
`AllocSessionKey(uint64_t peerNodeId, uint16_t keyId, WeaveConnection boundCon, WeaveSessionKey & sessionKey)`	`WEAVE_ERROR`
`ClearFabricState(void)`	`void`
`CreateFabric(void)`	`WEAVE_ERROR`
`FindSessionKey(uint16_t keyId, uint64_t peerNodeId, bool create, WeaveSessionKey *& retRec)`	`WEAVE_ERROR` 這個方法會尋找工作階段金鑰項目。
`FindSharedSession(uint64_t terminatingNodeId, WeaveAuthMode authMode, uint8_t encType)`	`WeaveSessionKey *` 搜尋工作階段金鑰資料表，找出已建立的共用工作階段金鑰 (指定目標為指定終止節點，且符合指定的驗證模式和加密類型)。
`GetFabricState(uint8_t *buf, uint32_t bufSize, uint32_t & fabricStateLen)`	`WEAVE_ERROR`
`GetPassword(uint8_t pwSrc, const char *& ps, uint16_t & pwLen)`	`WEAVE_ERROR`
`GetSessionKey(uint16_t keyId, uint64_t peerNodeId, WeaveSessionKey *& outSessionKey)`	`WEAVE_ERROR`
`GetSessionState(uint64_t remoteNodeId, uint16_t keyId, uint8_t encType, WeaveConnection *con, WeaveSessionState & outSessionState)`	`WEAVE_ERROR`
`GetSharedSessionEndNodeIds(const WeaveSessionKey sessionKey, uint64_t endNodeIds, uint8_t endNodeIdsBufSize, uint8_t & endNodeIdsCount)`	`WEAVE_ERROR` 這個方法會傳回共用指定工作階段的所有結束節點 ID。
`HandleConnectionClosed(WeaveConnection *con)`	`void`
`Init(void)`	`WEAVE_ERROR`
`Init(nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase *groupKeyStore)`	`WEAVE_ERROR`
`IsFabricAddress(const IPAddress & addr) const`	`bool` 判斷 IP 位址是否代表當地 Weave 布料中某個節點的位址。
`IsLocalFabricAddress(const IPAddress & addr) const`	`bool` 判斷 IP 位址是否代表本機節點的 Weave 布料位址。
`IsSharedSession(uint16_t keyId, uint64_t peerNodeId)`	`bool` 這個方法會檢查與指定對等點和 keyId 相關聯的安全工作階段是否共用。
`JoinExistingFabric(const uint8_t *fabricState, uint32_t fabricStateLen)`	`WEAVE_ERROR`
`RegisterSessionEndCallback(SessionEndCbCtxt *sessionEndCb)`	`WEAVE_ERROR`
`RemoveIdleSessionKeys()`	`bool`
`RemoveSessionKey(uint16_t keyId, uint64_t peerNodeId)`	`WEAVE_ERROR`
`RemoveSessionKey(WeaveSessionKey *sessionKey, bool wasIdle)`	`void`
`RemoveSharedSessionEndNodes(const WeaveSessionKey *sessionKey)`	`void`
`RestoreSession(uint8_t *serializedSession, uint16_t serializedSessionLen)`	`WEAVE_ERROR` 將先前暫停的 Weave 安全性工作階段從序列化狀態還原。
`SelectNodeAddress(uint64_t nodeId, uint16_t subnet) const`	`IPAddress` 傳回包含指定節點 Weave ULA 的 IPAddress。
`SelectNodeAddress(uint64_t nodeId) const`	`IPAddress` 傳回包含指定節點 Weave ULA 的 IPAddress。
`SetDelegate(FabricStateDelegate *aDelegate)`	`void` 這個方法會設定委派物件。
`SetSessionKey(uint16_t keyId, uint64_t peerNodeId, uint8_t encType, WeaveAuthMode authMode, const WeaveEncryptionKey *encKey)`	`WEAVE_ERROR`
`SetSessionKey(WeaveSessionKey sessionKey, uint8_t encType, WeaveAuthMode authMode, const WeaveEncryptionKey encKey)`	`WEAVE_ERROR`
`Shutdown(void)`	`WEAVE_ERROR`
`SuspendSession(uint16_t keyId, uint64_t peerNodeId, uint8_t *buf, uint16_t bufSize, uint16_t & serializedSessionLen)`	`WEAVE_ERROR` 暫停並序列化作用中的 Weave 安全性工作階段狀態。

Structs
nl::Weave::WeaveFabricState::SessionEndCbCtxt

公開類型

PeerIndexType

uint8_t PeerIndexType

SessionEndCbFunct

void(* SessionEndCbFunct)(uint16_t keyId, uint64_t peerNodeId, void *context)

州

 State

公開屬性

AutoCreateKeys

bool AutoCreateKeys

DebugFabricId

uint64_t DebugFabricId

DefaultSubnet

uint16_t DefaultSubnet

FabricId

uint64_t FabricId

GroupKeyStore

nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase * GroupKeyStore

ListenIPv4Addr

IPAddress ListenIPv4Addr

ListenIPv6Addr

IPAddress ListenIPv6Addr

LocalNodeId

uint64_t LocalNodeId

LogKeys

bool LogKeys

MaxUnencUDPMsgIdRcvd

uint32_t MaxUnencUDPMsgIdRcvd[WEAVE_CONFIG_MAX_PEER_NODES]

MessageLayer

WeaveMessageLayer * MessageLayer

MostRecentlyUsedIndexes

PeerIndexType MostRecentlyUsedIndexes[WEAVE_CONFIG_MAX_PEER_NODES]

NodeId

uint64_t NodeId[WEAVE_CONFIG_MAX_PEER_NODES]

PairingCode

const char * PairingCode

州

uint8_t State

UnencRcvFlags

WeaveSessionState::ReceiveFlagsType UnencRcvFlags[WEAVE_CONFIG_MAX_PEER_NODES]

UseTestKey

bool UseTestKey

公開函式

AddSharedSessionEndNode

WEAVE_ERROR AddSharedSessionEndNode(
  uint64_t endNodeId,
  uint64_t terminatingNodeId,
  uint16_t keyId
)

AddSharedSessionEndNode

WEAVE_ERROR AddSharedSessionEndNode(
  WeaveSessionKey *sessionKey,
  uint64_t endNodeId
)

這個方法會將新的結束節點新增至共用端點記錄。

詳細資料

參數

`[in] sessionKey`	WeaveSessionKey 物件，代表應新增結束節點的工作階段。
`[in] endNodeId`	要新增的工作階段結束節點的節點 ID。

傳回值

`WEAVE_ERROR_TOO_MANY_SHARED_SESSION_END_NODES`	如果共用端點清單中沒有可用空間可以存放新項目。
`WEAVE_NO_ERROR`	成功時。

AllocSessionKey

WEAVE_ERROR AllocSessionKey(
  uint64_t peerNodeId,
  uint16_t keyId,
  WeaveConnection *boundCon,
  WeaveSessionKey *& sessionKey
)

ClearFabricState

void ClearFabricState(
  void
)

CreateFabric

WEAVE_ERROR CreateFabric(
  void
)

FindSessionKey

WEAVE_ERROR FindSessionKey(
  uint16_t keyId,
  uint64_t peerNodeId,
  bool create,
  WeaveSessionKey *& retRec
)

這個方法會尋找工作階段金鑰項目。

詳細資料

參數

`[in] keyId`	Weave 金鑰 ID。
`[in] peerNodeId`	對等點的節點 ID。
`[in] create`	布林值，表示如果找不到指定的鍵，是否應建立新金鑰。
`[out] retRec`	指向 WeaveSessionKey 物件的指標參照。

傳回值

`WEAVE_ERROR_WRONG_KEY_TYPE`	如果指定的索引鍵並非工作階段金鑰類型，
`WEAVE_ERROR_INVALID_ARGUMENT`	如果輸入引數的值有誤，
`WEAVE_ERROR_KEY_NOT_FOUND`	找不到指定的鍵。
`WEAVE_ERROR_TOO_MANY_KEYS`	如果沒有免付費項目，無法建立新的工作階段金鑰。
`WEAVE_NO_ERROR`	成功時。

FindSharedSession

WeaveSessionKey * FindSharedSession(
  uint64_t terminatingNodeId,
  WeaveAuthMode authMode,
  uint8_t encType
)

搜尋工作階段金鑰資料表，找出已建立的共用工作階段金鑰 (指定目標為指定終止節點，且符合指定的驗證模式和加密類型)。

詳細資料

參數

`[in] terminatingNodeId`	工作階段終止器的節點 ID。
`[in] authMode`	所需工作階段驗證模式。
`[in] encType`	所需的訊息加密類型。

傳回值

WeaveSessionKey

* 指向代表相符共用工作階段的 WeaveSessionKey 物件；若找不到相符的工作階段，則傳回空值。

GetFabricState

WEAVE_ERROR GetFabricState(
  uint8_t *buf,
  uint32_t bufSize,
  uint32_t & fabricStateLen
)

GetPassword

WEAVE_ERROR GetPassword(
  uint8_t pwSrc,
  const char *& ps,
  uint16_t & pwLen
)

GetSessionKey

WEAVE_ERROR GetSessionKey(
  uint16_t keyId,
  uint64_t peerNodeId,
  WeaveSessionKey *& outSessionKey
)

GetSessionState

WEAVE_ERROR GetSessionState(
  uint64_t remoteNodeId,
  uint16_t keyId,
  uint8_t encType,
  WeaveConnection *con,
  WeaveSessionState & outSessionState
)

GetSharedSessionEndNodeIds

WEAVE_ERROR GetSharedSessionEndNodeIds(
  const WeaveSessionKey *sessionKey,
  uint64_t *endNodeIds,
  uint8_t endNodeIdsBufSize,
  uint8_t & endNodeIdsCount
)

這個方法會傳回共用指定工作階段的所有結束節點 ID。

詳細資料

參數

`[in] sessionKey`	工作階段金鑰物件的指標。
`[in] endNodeIds`	指向節點 ID 緩衝區的指標。
`[in] endNodeIdsMaxCount`	緩衝區中可容納的節點 ID 數量上限。
`[out] endNodeIdsCount`	共用指定工作階段的結束節點 ID 數量。

傳回值

`WEAVE_ERROR_BUFFER_TOO_SMALL`	如果提供的結束節點 ID 緩衝區空間不足。
`WEAVE_NO_ERROR`	成功時。

HandleConnectionClosed

void HandleConnectionClosed(
  WeaveConnection *con
)

Init

WEAVE_ERROR Init(
  void
)

Init

WEAVE_ERROR Init(
  nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase *groupKeyStore
)

IsFabricAddress

bool IsFabricAddress(
  const IPAddress & addr
) const

判斷 IP 位址是否代表當地 Weave 布料中某個節點的位址。

IsLocalFabricAddress

bool IsLocalFabricAddress(
  const IPAddress & addr
) const

判斷 IP 位址是否代表本機節點的 Weave 布料位址。

IsSharedSession

bool IsSharedSession(
  uint16_t keyId,
  uint64_t peerNodeId
)

這個方法會檢查與指定對等點和 keyId 相關聯的安全工作階段是否共用。

詳細資料

參數

`[in] keyId`	工作階段金鑰 ID。
`[in] peerNodeId`	對等點的節點 ID。

傳回值

bool

是否共用指定的工作階段。

JoinExistingFabric

WEAVE_ERROR JoinExistingFabric(
  const uint8_t *fabricState,
  uint32_t fabricStateLen
)

RegisterSessionEndCallback

WEAVE_ERROR RegisterSessionEndCallback(
  SessionEndCbCtxt *sessionEndCb
)

RemoveIdleSessionKeys

bool RemoveIdleSessionKeys()

RemoveSessionKey

WEAVE_ERROR RemoveSessionKey(
  uint16_t keyId,
  uint64_t peerNodeId
)

RemoveSessionKey

void RemoveSessionKey(
  WeaveSessionKey *sessionKey,
  bool wasIdle
)

RemoveSharedSessionEndNodes

void RemoveSharedSessionEndNodes(
  const WeaveSessionKey *sessionKey
)

RestoreSession

WEAVE_ERROR RestoreSession(
  uint8_t *serializedSession,
  uint16_t serializedSessionLen
)

將先前暫停的 Weave 安全性工作階段從序列化狀態還原。

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId,
  uint16_t subnet
) const

傳回包含指定節點 Weave ULA 的 IPAddress。

這個變化版本可讓您指定子網路。

詳細資料

參數

`[in] nodeId`	相關節點的節點 ID 編號。
`[in] subnet`	所需的 ULA 子網路。

傳回值

IPAddress

IPAddress 物件。

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId
) const

傳回包含指定節點 Weave ULA 的 IPAddress。

這個變化版本會使用本機節點的預設子網路。

詳細資料

參數

[in] nodeId

相關節點的節點 ID 編號。

傳回值

IPAddress

IPAddress 物件。

SetDelegate

void SetDelegate(
  FabricStateDelegate *aDelegate
)

這個方法會設定委派物件。

每當 FabricId 發生變更時 (即加入/建立架構，或離開織布狀態時)，就會叫用委派的回呼方法

如果先前已設定委派，則對這個方法的第二次呼叫將會覆寫先前的委派。

詳細資料

參數

[in] aDelegate

委派物件。如果不需要委派，則可設為空值。

SetSessionKey

WEAVE_ERROR SetSessionKey(
  uint16_t keyId,
  uint64_t peerNodeId,
  uint8_t encType,
  WeaveAuthMode authMode,
  const WeaveEncryptionKey *encKey
)

SetSessionKey

WEAVE_ERROR SetSessionKey(
  WeaveSessionKey *sessionKey,
  uint8_t encType,
  WeaveAuthMode authMode,
  const WeaveEncryptionKey *encKey
)

關閉

WEAVE_ERROR Shutdown(
  void
)

SuspendSession

WEAVE_ERROR SuspendSession(
  uint16_t keyId,
  uint64_t peerNodeId,
  uint8_t *buf,
  uint16_t bufSize,
  uint16_t & serializedSessionLen
)

暫停並序列化作用中的 Weave 安全性工作階段狀態。

將已識別的 Weave 安全性工作階段狀態序列化到提供的緩衝區中，並暫停工作階段，以不再傳送或接收任何訊息。

這個方法適用於不在休眠時保留 RAM 的裝置，讓這類裝置可保留執行中工作階段的狀態，不必在醒來時重新建立工作階段。

WeaveFabricState

 WeaveFabricState(
  void
)

nl::Weave::WeaveFabricState

摘要

建構函式和解構函式

公開類型

公開屬性

公開函式

Structs

公開類型

PeerIndexType

SessionEndCbFunct

州

公開屬性

AutoCreateKeys

DebugFabricId

DefaultSubnet

FabricId

GroupKeyStore

ListenIPv4Addr

ListenIPv6Addr

LocalNodeId

LogKeys

MaxUnencUDPMsgIdRcvd

MessageLayer

MostRecentlyUsedIndexes

NodeId

PairingCode

州

UnencRcvFlags

UseTestKey

公開函式

AddSharedSessionEndNode

AddSharedSessionEndNode

AllocSessionKey

ClearFabricState

CreateFabric

FindSessionKey

FindSharedSession

GetFabricState

GetPassword

GetSessionKey

GetSessionState

GetSharedSessionEndNodeIds

HandleConnectionClosed

Init

Init

IsFabricAddress

IsLocalFabricAddress

IsSharedSession

JoinExistingFabric

RegisterSessionEndCallback

RemoveIdleSessionKeys

RemoveSessionKey

RemoveSessionKey

RemoveSharedSessionEndNodes

RestoreSession

SelectNodeAddress

SelectNodeAddress

SetDelegate

SetSessionKey

SetSessionKey

關閉

SuspendSession

WeaveFabricState