nl::Weave::WeaveSessionKey

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

Zawiera informacje o kluczu sesji Weave.

Podsumowanie

Typy publiczne

FlagsEnum{
  kFlag_IsLocallyInitiated = 0x01,
  kFlag_IsSharedSession = 0x02,
  kFlag_IsRemoveOnIdle = 0x04,
  kFlag_RecentlyActive = 0x08,
  kFlag_Suspended = 0x10
}
enum | typ wyliczeniowy

Atrybuty publiczne

AuthMode
WeaveAuthMode
Środki, za pomocą których węzeł równorzędny został uwierzytelniony podczas nawiązywania sesji.
BoundCon
Połączenie, z którym powiązany jest klucz.
Flags
uint8_t
Różne flagi powiązane z sesją.
MaxRcvdMsgId
uint32_t
Maksymalna wartość identyfikatora wiadomości odebranego w ramach klucza sesji.
MsgEncKey
Klucz szyfrowania wiadomości Weave.
NextMsgId
Następny identyfikator wiadomości, który ma być używany w kluczu sesji.
NodeId
uint64_t
Identyfikator węzła, któremu udostępniono klucz sesji.
RcvFlags
WeaveSessionState::ReceiveFlagsType
Służy do oznaczenia wiadomości śledzących otrzymane pod kluczem.
ReserveCount
uint8_t
Liczba rezerwacji klucza sesji.

Funkcje publiczne

Clear(void)
void
Zresetuj obiekt WeaveSessionKey.
ClearRecentlyActive()
void
Wskazuje, że sesja NIE była aktywna w przeszłości.
ClearSuspended()
void
Init(void)
void
Zainicjuj obiekt WeaveSessionKey.
IsAllocated() const
bool
IsKeySet() const
bool
IsLocallyInitiated() const
bool
IsRecentlyActive() const
bool
IsRemoveOnIdle() const
bool
IsSharedSession() const
bool
IsSuspended() const
bool
MarkRecentlyActive()
void
Wskazuje, że sesja była aktywna w przeszłości.
MarkSuspended()
void
SetLocallyInitiated(bool val)
void
SetRemoveOnIdle(bool val)
void
Ustawia flagę wskazującą, czy sesja powinna zostać automatycznie usunięta po okresie bezczynności.
SetSharedSession(bool val)
void
Ustawia flagę wskazującą, czy sesja jest sesją współdzieloną.

Typy publiczne

FlagsEnum

 FlagsEnum
Właściwości
kFlag_IsLocallyInitiated

Sesja została zainicjowana przez węzeł lokalny.

kFlag_IsRemoveOnIdle

Sesja powinna zostać usunięta, gdy jest nieaktywna (dotyczy tylko sesji, które nie są powiązane z połączeniem).

kFlag_IsSharedSession

Jest to sesja współdzielona.

kFlag_RecentlyActive

Sesja była niedawno aktywna.

kFlag_Suspended

Sesja została zawieszona.

Atrybuty publiczne

AuthMode

WeaveAuthMode AuthMode

Środki, za pomocą których węzeł równorzędny został uwierzytelniony podczas nawiązywania sesji.

BoundCon

WeaveConnection * BoundCon

Połączenie, z którym powiązany jest klucz.

Flagi

uint8_t Flags

Różne flagi powiązane z sesją.

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

Maksymalna wartość identyfikatora wiadomości odebranego w ramach klucza sesji.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

Klucz szyfrowania wiadomości Weave.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

Następny identyfikator wiadomości, który ma być używany w kluczu sesji.

NodeId

uint64_t NodeId

Identyfikator węzła, któremu udostępniono klucz sesji.

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

Służy do oznaczenia wiadomości śledzących otrzymane pod kluczem.

ReserveCount

uint8_t ReserveCount

Liczba rezerwacji klucza sesji.

Funkcje publiczne

Wyczyść

void Clear(
  void
)

Zresetuj obiekt WeaveSessionKey.

ClearRecentlyActive

void ClearRecentlyActive()

Wskazuje, że sesja NIE była aktywna w przeszłości.

ClearSuspended

void ClearSuspended()

Zainicjuj

void Init(
  void
)

Zainicjuj obiekt WeaveSessionKey.

IsAllocated

bool IsAllocated() const 

Szczegóły
Zwroty
Prawda, jeśli obiekt WeaveSessionKey jest przydzielony.

IsKeySet

bool IsKeySet() const 

Szczegóły
Zwroty
Prawda, jeśli wartość klucza szyfrowania została ustawiona w obiekcie WeaveSessionKey.

IsLocallyInitiated

bool IsLocallyInitiated() const 

Szczegóły
Zwroty
Prawda, jeśli sesja została zainicjowana przez węzeł lokalny.

IsRecentlyActive

bool IsRecentlyActive() const 

Szczegóły
Zwroty
Prawda, jeśli sesja była aktywna w przeszłości.

IsRemoveOnIdle

bool IsRemoveOnIdle() const 

Szczegóły
Zwroty
Prawda, jeśli sesja została oznaczona do automatycznego usunięcia w przypadku nieaktywności przez określony czas.

IsSharedSession

bool IsSharedSession() const 

IsSuspended

bool IsSuspended() const 

MarkRecentlyActive

void MarkRecentlyActive()

Wskazuje, że sesja była aktywna w przeszłości.

MarkSuspended

void MarkSuspended()

SetLocallyInitiated

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

Ustawia flagę wskazującą, czy sesja powinna zostać automatycznie usunięta po okresie bezczynności.

Szczegóły
Parametry
[in] val
Wartość ustawienia flagi kFlag_IsRemoveOnIdle.

SetSharedSession

void SetSharedSession(
  bool val
)

Ustawia flagę wskazującą, czy sesja jest sesją współdzieloną.

Szczegóły
Parametry
[in] val
Wartość ustawienia flagi kFlag_IsSharedSession.