Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

このページは 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`	enum

パブリック属性
`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 セキュリティセッションの一時停止とシリアル化を行います。

構造体
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 オブジェクトへのポインタ。一致するセッションが見つからなかった場合は NULL。

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 が変更されるたびに呼び出されます（ファブリックへの参加時や作成時、またはファブリックからの退出（ファブリック状態をクリア））。

以前にデリゲートが設定されている場合、このメソッドの 2 回目の呼び出しで以前のデリゲートが上書きされます。

詳細

パラメータ

[in] aDelegate

委譲オブジェクト。委譲が不要な場合は NULL にできます。

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

概要

コンストラクタとデストラクタ

パブリック タイプ

パブリック属性

パブリック関数

構造体

パブリック タイプ

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

パブリックタイプ

パブリックタイプ