Ta strona została przetłumaczona przez Cloud Translation API.

nl::Weave::WeaveFabricState

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

Wychodząca deklaracja stanu WeaveFabricState.

Podsumowanie

Konstruktory i niszczyciele
`WeaveFabricState(void)`

Typy publiczne
`PeerIndexType`	typedef `uint8_t`
`SessionEndCbFunct)(uint16_t keyId, uint64_t peerNodeId, void *context)`	typedef `void(*`
`State`	enum \| typ wyliczeniowy

Atrybuty publiczne
`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`

Funkcje publiczne
`AddSharedSessionEndNode(uint64_t endNodeId, uint64_t terminatingNodeId, uint16_t keyId)`	`WEAVE_ERROR`
`AddSharedSessionEndNode(WeaveSessionKey *sessionKey, uint64_t endNodeId)`	`WEAVE_ERROR` Ta metoda dodaje nowy węzeł końcowy do rekordu współdzielonych węzłów końcowych.
`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` Ta metoda znajduje wpis klucza sesji.
`FindSharedSession(uint64_t terminatingNodeId, WeaveAuthMode authMode, uint8_t encType)`	`WeaveSessionKey *` W tabeli kluczy sesji wyszukaj utworzony klucz współdzielonej sesji, który jest kierowany na określony węzeł zamykający i pasuje do danego trybu uwierzytelniania i typu szyfrowania.
`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` Ta metoda zwraca wszystkie identyfikatory węzłów końcowych, które współdzielą określoną sesję.
`HandleConnectionClosed(WeaveConnection *con)`	`void`
`Init(void)`	`WEAVE_ERROR`
`Init(nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase *groupKeyStore)`	`WEAVE_ERROR`
`IsFabricAddress(const IPAddress & addr) const`	`bool` Określa, czy adres IP reprezentuje adres węzła w lokalnej tkaninie Weave.
`IsLocalFabricAddress(const IPAddress & addr) const`	`bool` Określa, czy adres IP reprezentuje adres tkaniny Weave dla węzła lokalnego.
`IsSharedSession(uint16_t keyId, uint64_t peerNodeId)`	`bool` Ta metoda sprawdza, czy bezpieczna sesja powiązana z określonym peerem i identyfikatorem klucza jest udostępniana.
`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` Przywracanie wcześniej zawieszonej sesji zabezpieczeń Weave ze stanu zserializowanego.
`SelectNodeAddress(uint64_t nodeId, uint16_t subnet) const`	`IPAddress` Zwraca adres IP zawierający identyfikator ULA Weave dla określonego węzła.
`SelectNodeAddress(uint64_t nodeId) const`	`IPAddress` Zwraca adres IP zawierający identyfikator ULA Weave dla określonego węzła.
`SetDelegate(FabricStateDelegate *aDelegate)`	`void` Ta metoda ustawia obiekt delegata.
`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` Zawieszenie i zserializowanie stanu aktywnej sesji zabezpieczeń Weave.

Struktura
nl::Weave::WeaveFabricState::SessionEndCbCtxt

Typy publiczne

PeerIndexType

uint8_t PeerIndexType

SessionEndCbFunct

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

Stan

 State

Atrybuty publiczne

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

Stan

uint8_t State

UnencRcvFlags

WeaveSessionState::ReceiveFlagsType UnencRcvFlags[WEAVE_CONFIG_MAX_PEER_NODES]

UseTestKey

bool UseTestKey

Funkcje publiczne

AddSharedSessionEndNode

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

AddSharedSessionEndNode

WEAVE_ERROR AddSharedSessionEndNode(
  WeaveSessionKey *sessionKey,
  uint64_t endNodeId
)

Ta metoda dodaje nowy węzeł końcowy do rekordu współdzielonych węzłów końcowych.

Szczegóły

Parametry

`[in] sessionKey`	Obiekt WeaveSessionKey reprezentujący sesję, do której ma zostać dodany nowy węzeł końcowy.
`[in] endNodeId`	Identyfikator węzła końcowego sesji, który ma zostać dodany.

Zwracane wartości

`WEAVE_ERROR_TOO_MANY_SHARED_SESSION_END_NODES`	Jeśli na liście udostępnionych węzłów końcowych nie ma wolnego miejsca na nowy wpis.
`WEAVE_NO_ERROR`	Powodzenie.

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
)

Ta metoda znajduje wpis klucza sesji.

Szczegóły

Parametry

`[in] keyId`	Identyfikator klucza Weave.
`[in] peerNodeId`	Identyfikator węzła peera.
`[in] create`	Wartość logiczna wskazująca, czy należy utworzyć nowy klucz, jeśli określony klucz nie zostanie znaleziony.
`[out] retRec`	Odwołanie wskaźnika do obiektu WeaveSessionKey.

Zwracane wartości

`WEAVE_ERROR_WRONG_KEY_TYPE`	Jeśli podany klucz nie jest typem klucza sesji.
`WEAVE_ERROR_INVALID_ARGUMENT`	Jeśli argumenty wejściowe mają nieprawidłowe wartości.
`WEAVE_ERROR_KEY_NOT_FOUND`	Jeśli nie udało się znaleźć podanego klucza.
`WEAVE_ERROR_TOO_MANY_KEYS`	Jeśli nie ma wolnego miejsca, aby utworzyć nowy klucz sesji.
`WEAVE_NO_ERROR`	Powodzenie.

FindSharedSession

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

W tabeli kluczy sesji wyszukaj utworzony klucz współdzielonej sesji, który jest kierowany na określony węzeł zamykający i pasuje do danego trybu uwierzytelniania i typu szyfrowania.

Szczegóły

Parametry

`[in] terminatingNodeId`	Identyfikator węzła zakończenia sesji.
`[in] authMode`	Wybrany tryb uwierzytelniania sesji.
`[in] encType`	Wybrany typ szyfrowania wiadomości.

Zwracane wartości

WeaveSessionKey

* Wskaźnik do obiektu WeaveSessionKey reprezentującego pasującą sesję współdzieloną; lub NULL, jeśli nie znaleziono pasującej sesji.

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
)

Ta metoda zwraca wszystkie identyfikatory węzłów końcowych, które współdzielą określoną sesję.

Szczegóły

Parametry

`[in] sessionKey`	Wskaźnik do obiektu klucza sesji.
`[in] endNodeIds`	Wskaźnik do bufora identyfikatorów węzłów.
`[in] endNodeIdsMaxCount`	Maksymalna liczba identyfikatorów węzłów, które mogą się zmieścić w buforze.
`[out] endNodeIdsCount`	Liczba znalezionych identyfikatorów węzłów końcowych, które współdzielą określoną sesję.

Zwracane wartości

`WEAVE_ERROR_BUFFER_TOO_SMALL`	Jeśli podany bufor identyfikatorów węzłów końcowych nie jest wystarczająco duży.
`WEAVE_NO_ERROR`	Powodzenie.

HandleConnectionClosed

void HandleConnectionClosed(
  WeaveConnection *con
)

Rozpocznij

WEAVE_ERROR Init(
  void
)

Rozpocznij

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

IsFabricAddress

bool IsFabricAddress(
  const IPAddress & addr
) const

Określa, czy adres IP reprezentuje adres węzła w lokalnej tkaninie Weave.

IsLocalFabricAddress

bool IsLocalFabricAddress(
  const IPAddress & addr
) const

Określa, czy adres IP reprezentuje adres tkaniny Weave dla węzła lokalnego.

IsSharedSession

bool IsSharedSession(
  uint16_t keyId,
  uint64_t peerNodeId
)

Ta metoda sprawdza, czy bezpieczna sesja powiązana z określonym peerem i identyfikatorem klucza jest udostępniana.

Szczegóły

Parametry

`[in] keyId`	Identyfikator klucza sesji.
`[in] peerNodeId`	Identyfikator węzła peera.

Zwracane wartości

bool

Określa, czy określona sesja jest udostępniana.

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
)

Przywracanie wcześniej zawieszonej sesji zabezpieczeń Weave ze stanu zserializowanego.

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId,
  uint16_t subnet
) const

Zwraca adres IP zawierający identyfikator ULA Weave dla określonego węzła.

Ten wariant umożliwia określenie podsieci.

Szczegóły

Parametry

`[in] nodeId`	Numer identyfikacyjny węzła danego węzła.
`[in] subnet`	Żądana podsieć ULA.

Zwracane wartości

IPAddress

Obiekt IPAddress.

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId
) const

Zwraca adres IP zawierający identyfikator ULA Weave dla określonego węzła.

Ten wariant używa domyślnej podsieci węzła lokalnego.

Szczegóły

Parametry

[in] nodeId

Numer identyfikacyjny węzła danego węzła.

Zwracane wartości

IPAddress

Obiekt IPAddress.

SetDelegate

void SetDelegate(
  FabricStateDelegate *aDelegate
)

Ta metoda ustawia obiekt delegata.

Metody wywołania zwrotnego osoby, której przekazano dostęp, są wywoływane za każdym razem, gdy zmienia się identyfikator FabricId, tj.gdy dołączasz do tkaniny/utworzymy tkaninę lub gdy opuszczamy tkaninę (przez jasny stan tkaniny).

Jeśli osoba, której przekazano dostęp, została ustawiona wcześniej, drugie wywołanie tej metody spowoduje zastąpienie poprzedniego.

Szczegóły

Parametry

[in] aDelegate

Obiekt z przekazanym dostępem. Jeśli delegat nie jest wymagany, może mieć wartość 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
)

Wyłączono

WEAVE_ERROR Shutdown(
  void
)

SuspendSession

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

Zawieszenie i zserializowanie stanu aktywnej sesji zabezpieczeń Weave.

Serializuje stan zidentyfikowanej sesji zabezpieczeń Weave w dostarczonym buforze i zawiesza sesję, przez co nie można wysyłać ani odbierać dalszych wiadomości.

Ta metoda jest przeznaczona dla urządzeń, które nie zachowują pamięci RAM podczas uśpienia. Pozwala im zachować stan aktywnej sesji, a tym samym uniknąć konieczności ponownego ustanowienia sesji po wybudzeniu.

WeaveFabricState

 WeaveFabricState(
  void
)

nl::Weave::WeaveFabricState

Podsumowanie

Konstruktory i niszczyciele

Typy publiczne

Atrybuty publiczne

Funkcje publiczne

Struktura

Typy publiczne

PeerIndexType

SessionEndCbFunct

Stan

Atrybuty publiczne

AutoCreateKeys

DebugFabricId

DefaultSubnet

FabricId

GroupKeyStore

ListenIPv4Addr

ListenIPv6Addr

LocalNodeId

LogKeys

MaxUnencUDPMsgIdRcvd

MessageLayer

MostRecentlyUsedIndexes

NodeId

PairingCode

Stan

UnencRcvFlags

UseTestKey

Funkcje publiczne

AddSharedSessionEndNode

AddSharedSessionEndNode

AllocSessionKey

ClearFabricState

CreateFabric

FindSessionKey

FindSharedSession

GetFabricState

GetPassword

GetSessionKey

GetSessionState

GetSharedSessionEndNodeIds

HandleConnectionClosed

Rozpocznij

Rozpocznij

IsFabricAddress

IsLocalFabricAddress

IsSharedSession

JoinExistingFabric

RegisterSessionEndCallback

RemoveIdleSessionKeys

RemoveSessionKey

RemoveSessionKey

RemoveSharedSessionEndNodes

RestoreSession

SelectNodeAddress

SelectNodeAddress

SetDelegate

SetSessionKey

SetSessionKey

Wyłączono

SuspendSession

WeaveFabricState