nl::Weave::WeaveSessionKey

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

Enthält Informationen zu einem Weave-Sitzungsschlüssel.

Zusammenfassung

Öffentliche Typen

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

Öffentliche Attribute

AuthMode
WeaveAuthMode
Die Methode, mit der der Peer-Knoten während des Sitzungsaufbaus authentifiziert wurde.
BoundCon
Die Verbindung, an die der Schlüssel gebunden ist.
Flags
uint8_t
Verschiedene Flags, die der Sitzung zugeordnet sind.
MaxRcvdMsgId
uint32_t
Die maximale Nachrichten-ID, die unter dem Sitzungsschlüssel empfangen wurde.
MsgEncKey
Der Weave-Nachrichtenverschlüsselungsschlüssel.
NextMsgId
Die nächste Nachrichten-ID, die unter dem Sitzungsschlüssel verwendet wird.
NodeId
uint64_t
Die ID des Knotens, für den der Sitzungsschlüssel freigegeben wird.
RcvFlags
WeaveSessionState::ReceiveFlagsType
Kennzeichnet Tracking-Nachrichten, die unter dem Schlüssel empfangen wurden.
ReserveCount
uint8_t
Gibt an, wie oft der Sitzungsschlüssel reserviert wurde.

Öffentliche Funktionen

Clear(void)
void
WeaveSessionKey-Objekt zurücksetzen
ClearRecentlyActive()
void
Signalisiert, dass die Sitzung in letzter Zeit NICHT aktiv war.
ClearSuspended()
void
Init(void)
void
Initialisieren Sie ein WeaveSessionKey-Objekt.
IsAllocated() const
bool
IsKeySet() const
bool
IsLocallyInitiated() const
bool
IsRecentlyActive() const
bool
IsRemoveOnIdle() const
bool
IsSharedSession() const
bool
IsSuspended() const
bool
MarkRecentlyActive()
void
Signalisiert, dass die Sitzung in der jüngsten Vergangenheit aktiv war.
MarkSuspended()
void
SetLocallyInitiated(bool val)
void
SetRemoveOnIdle(bool val)
void
Legt ein Flag fest, das angibt, ob die Sitzung nach einer bestimmten Inaktivitätszeit automatisch entfernt werden soll.
SetSharedSession(bool val)
void
Legt ein Flag fest, das angibt, ob die Sitzung eine freigegebene Sitzung ist.

Öffentliche Typen

FlagsEnum

 FlagsEnum
Attribute
kFlag_IsLocallyInitiated

Die Sitzung wurde vom lokalen Knoten initiiert.

kFlag_IsRemoveOnIdle

Die Sitzung sollte bei Inaktivität entfernt werden (gilt nur für Sitzungen, die nicht an eine Verbindung gebunden sind).

kFlag_IsSharedSession

Die Sitzung ist eine freigegebene Sitzung.

kFlag_RecentlyActive

Die Sitzung war vor Kurzem aktiv.

kFlag_Suspended

Die Sitzung wurde ausgesetzt.

Öffentliche Attribute

AuthMode

WeaveAuthMode AuthMode

Die Methode, mit der der Peer-Knoten während des Sitzungsaufbaus authentifiziert wurde.

BoundCon

WeaveConnection * BoundCon

Die Verbindung, an die der Schlüssel gebunden ist.

Flags

uint8_t Flags

Verschiedene Flags, die der Sitzung zugeordnet sind.

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

Die maximale Nachrichten-ID, die unter dem Sitzungsschlüssel empfangen wurde.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

Der Weave-Nachrichtenverschlüsselungsschlüssel.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

Die nächste Nachrichten-ID, die unter dem Sitzungsschlüssel verwendet wird.

NodeId

uint64_t NodeId

Die ID des Knotens, für den der Sitzungsschlüssel freigegeben wird.

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

Kennzeichnet Tracking-Nachrichten, die unter dem Schlüssel empfangen wurden.

ReserveCount

uint8_t ReserveCount

Gibt an, wie oft der Sitzungsschlüssel reserviert wurde.

Öffentliche Funktionen

Löschen

void Clear(
  void
)

WeaveSessionKey-Objekt zurücksetzen

ClearRecentlyActive

void ClearRecentlyActive()

Signalisiert, dass die Sitzung in der letzten Zeit NICHT aktiv war.

ClearSuspended

void ClearSuspended()

Init

void Init(
  void
)

Initialisieren Sie ein WeaveSessionKey-Objekt.

IsAllocated

bool IsAllocated() const 

Details
Rückgabe
"True", wenn das Objekt WeaveSessionKey zugewiesen ist.

IsKeySet

bool IsKeySet() const 

Details
Rückgabe
"True", wenn der Wert des Verschlüsselungsschlüssels in einem WeaveSessionKey-Objekt festgelegt wurde.

IsLocallyInitiated

bool IsLocallyInitiated() const 

Details
Rückgabe
"True", wenn die Sitzung vom lokalen Knoten initiiert wurde.

IsRecentlyActive

bool IsRecentlyActive() const 

Details
Rückgabe
Dieser Wert ist „True“, wenn die Sitzung in letzter Zeit aktiv war.

IsRemoveOnIdle

bool IsRemoveOnIdle() const 

Details
Rückgabe
Dieser Wert ist „True“, wenn die Sitzung nach einer bestimmten Zeit der Inaktivität zum automatischen Löschen gekennzeichnet ist.

IsSharedSession

bool IsSharedSession() const 

IsSuspended

bool IsSuspended() const 

MarkRecentlyActive

void MarkRecentlyActive()

Signalisiert, dass die Sitzung in der jüngsten Vergangenheit aktiv war.

MarkSuspended

void MarkSuspended()

SetLocallyInitiated

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

Legt ein Flag fest, das angibt, ob die Sitzung nach einer bestimmten Inaktivitätszeit automatisch entfernt werden soll.

Details
Parameter
[in] val
Der Wert, auf den das Flag kFlag_IsRemoveOnIdle gesetzt werden soll.

SetSharedSession

void SetSharedSession(
  bool val
)

Legt ein Flag fest, das angibt, ob die Sitzung eine freigegebene Sitzung ist.

Details
Parameter
[in] val
Der Wert, auf den das Flag „kFlag_IsSharedSession“ gesetzt werden soll.