nl:: Weave:: WeaveSessionKey
#include <src/lib/core/WeaveFabricState.h>
Zawiera informacje o kluczu sesji Weave.
Podsumowanie
Typy publiczne |
|
---|---|
FlagsEnum{
|
enum | typ wyliczeniowy |
Atrybuty publiczne |
|
---|---|
AuthMode
|
WeaveAuthMode
Środki, za pomocą których węzeł równorzędny został uwierzytelniony podczas ustanawiania sesji.
|
BoundCon
|
Połączenie, z którym powiązany jest klucz.
|
Flags
|
uint8_t
Różne flagi powiązane z sesją.
|
MaxRcvdMsgId
|
uint32_t
Maksymalny identyfikator wiadomości otrzymany w ramach klucza sesji.
|
MsgEncKey
|
klucz szyfrowania wiadomości Weave,
|
NextMsgId
|
Identyfikator następnej wiadomości do użycia w kluczu sesji.
|
NodeId
|
uint64_t
Identyfikator węzła, któremu udostępniany jest klucz sesji.
|
RcvFlags
|
WeaveSessionState::ReceiveFlagsType
Flagi śledzące wiadomości odebrane pod kluczem.
|
ReserveCount
|
uint8_t
Liczba rezerwacji klucza sesji.
|
Funkcje publiczne |
|
---|---|
Clear(void)
|
void
Zresetuj obiekt WeaveSessionKey.
|
ClearRecentlyActive()
|
void
Oznacza sesję jako NIEAktywną 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 niedawnej przeszłości.
|
MarkSuspended()
|
void
|
SetLocallyInitiated(bool val)
|
void
|
SetRemoveOnIdle(bool val)
|
void
Ustawia flagę wskazującą, czy sesja ma 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 należy usunąć w przypadku bezczynności (dotyczy tylko sesji, które nie są powiązane z połączeniem). |
kFlag_IsSharedSession
|
Jest to sesja współdzielona. |
kFlag_RecentlyActive
|
Sesja była ostatnio 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 ustanawiania sesji.
Flagi
uint8_t Flags
Różne flagi powiązane z sesją.
MaxRcvdMsgId
uint32_t MaxRcvdMsgId
Maksymalny identyfikator wiadomości otrzymany w ramach klucza sesji.
NextMsgId
MonotonicallyIncreasingCounter NextMsgId
Identyfikator następnej wiadomości do użycia w kluczu sesji.
NodeId
uint64_t NodeId
Identyfikator węzła, któremu udostępniany jest klucz sesji.
RcvFlags
WeaveSessionState::ReceiveFlagsType RcvFlags
Flagi śledzące wiadomości odebrane pod kluczem.
ReserveCount
uint8_t ReserveCount
Liczba rezerwacji klucza sesji.
Funkcje publiczne
ClearRecentlyActive
void ClearRecentlyActive()
Sygnalizuje, że sesja NIE była aktywna w przeszłości.
ClearSuspended
void ClearSuspended()
IsAllocated
bool IsAllocated() const
Szczegóły | |
---|---|
Zwroty |
Prawda, jeśli przydzielony jest obiekt WeaveSessionKey.
|
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 niedawnej przeszłości.
|
IsRemoveOnIdle
bool IsRemoveOnIdle() const
Szczegóły | |
---|---|
Zwroty |
Prawda, jeśli sesja jest oznaczona do automatycznego usuwania, gdy przez pewien czas jest nieaktywna.
|
IsSharedSession
bool IsSharedSession() const
IsSuspended
bool IsSuspended() const
MarkRecentlyActive
void MarkRecentlyActive()
Wskazuje, że sesja była aktywna w niedawnej 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 |
|
SetSharedSession
void SetSharedSession( bool val )
Ustawia flagę wskazującą, czy sesja jest sesją współdzieloną.
Szczegóły | |||
---|---|---|---|
Parametry |
|