Diese Seite wurde von der Cloud Translation API übersetzt.

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, über die der Peer-Knoten während der Sitzungseinrichtung authentifiziert wurde.
`BoundCon`	`WeaveConnection *` Die Verbindung, an die der Schlüssel gebunden ist.
`Flags`	`uint8_t` Verschiedene Flags, die der Sitzung zugeordnet sind.
`MaxRcvdMsgId`	`uint32_t` Die maximal unter dem Sitzungsschlüssel empfangene Nachrichten-ID.
`MsgEncKey`	`WeaveMsgEncryptionKey` Der Weave-Nachrichtenverschlüsselungsschlüssel.
`NextMsgId`	`MonotonicallyIncreasingCounter` Die nächste Nachrichten-ID, die unter dem Sitzungsschlüssel verwendet werden soll.
`NodeId`	`uint64_t` Die ID des Knotens, für den der Sitzungsschlüssel freigegeben wird.
`RcvFlags`	`WeaveSessionState::ReceiveFlagsType` Flags, die Nachrichten verfolgen, die unter dem Schlüssel empfangen wurden.
`ReserveCount`	`uint8_t` Gibt an, wie oft der Sitzungsschlüssel reserviert wurde.

Öffentliche Funktionen
`Clear(void)`	`void` Setzen Sie ein WeaveSessionKey-Objekt zurück.
`ClearRecentlyActive()`	`void` Gibt an, dass die Sitzung in der jüngsten Vergangenheit 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` Gibt an, dass die Sitzung vor Kurzem 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, über die der Peer-Knoten während der Sitzungseinrichtung 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 maximal unter dem Sitzungsschlüssel empfangene Nachrichten-ID.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

Der Weave-Nachrichtenverschlüsselungsschlüssel.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

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

NodeId

uint64_t NodeId

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

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

Flags, die Nachrichten verfolgen, die unter dem Schlüssel empfangen wurden.

ReserveCount

uint8_t ReserveCount

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

Öffentliche Funktionen

Klar

void Clear(
  void
)

Setzen Sie ein WeaveSessionKey-Objekt zurück.

ClearRecentlyActive

void ClearRecentlyActive()

Gibt an, dass die Sitzung in der jüngsten Vergangenheit 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 WeaveSessionKey-Objekt 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	„True“, wenn die Sitzung vor Kurzem aktiv war.

IsRemoveOnIdle

bool IsRemoveOnIdle() const

Details
Rückgabe	„True“, wenn die Sitzung bei einer bestimmten Zeit der Inaktivität zur automatischen Entfernung gekennzeichnet wird.

IsSharedSession

bool IsSharedSession() const

IsSuspended

bool IsSuspended() const

MarkRecentlyActive

void MarkRecentlyActive()

Gibt an, dass die Sitzung vor Kurzem 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

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.