Cette page a été traduite par l'API Cloud Translation.

nl::Weave::WeaveSessionKey

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

Contient des informations sur une clé de session Weave.

Résumé

Types publics
`FlagsEnum{ kFlag_IsLocallyInitiated = 0x01, kFlag_IsSharedSession = 0x02, kFlag_IsRemoveOnIdle = 0x04, kFlag_RecentlyActive = 0x08, kFlag_Suspended = 0x10 }`	énum

Attributs publics
`AuthMode`	`WeaveAuthMode` Moyen par lequel le nœud pair a été authentifié lors de l'établissement d'une session.
`BoundCon`	`WeaveConnection *` Connexion à laquelle la clé est liée.
`Flags`	`uint8_t` Différents indicateurs associés à la session.
`MaxRcvdMsgId`	`uint32_t` ID maximal du message reçu sous la clé de session.
`MsgEncKey`	`WeaveMsgEncryptionKey` Clé de chiffrement des messages Weave.
`NextMsgId`	`MonotonicallyIncreasingCounter` Identifiant de message suivant à utiliser sous la clé de session.
`NodeId`	`uint64_t` Identifiant du nœud avec lequel la clé de session est partagée.
`RcvFlags`	`WeaveSessionState::ReceiveFlagsType` Indicateurs de suivi des messages reçus sous la clé.
`ReserveCount`	`uint8_t` Nombre de fois où la clé de session a été réservée.

Fonctions publiques
`Clear(void)`	`void` Réinitialisez un objet WeaveSessionKey.
`ClearRecentlyActive()`	`void` Indique que la session n'a PAS été active récemment.
`ClearSuspended()`	`void`
`Init(void)`	`void` Initialisez un objet WeaveSessionKey.
`IsAllocated() const`	`bool`
`IsKeySet() const`	`bool`
`IsLocallyInitiated() const`	`bool`
`IsRecentlyActive() const`	`bool`
`IsRemoveOnIdle() const`	`bool`
`IsSharedSession() const`	`bool`
`IsSuspended() const`	`bool`
`MarkRecentlyActive()`	`void` Indique que la session a été active récemment.
`MarkSuspended()`	`void`
`SetLocallyInitiated(bool val)`	`void`
`SetRemoveOnIdle(bool val)`	`void` Définit un indicateur indiquant si la session doit être automatiquement supprimée après une période d'inactivité.
`SetSharedSession(bool val)`	`void` Définit un indicateur indiquant si la session est une session partagée.

Types publics

FlagsEnum

 FlagsEnum

Propriétés
`kFlag_IsLocallyInitiated`	La session a été lancée par le nœud local.
`kFlag_IsRemoveOnIdle`	La session doit être supprimée en cas d'inactivité (ne s'applique qu'aux sessions qui ne sont pas liées à une connexion).
`kFlag_IsSharedSession`	Il s'agit d'une session partagée.
`kFlag_RecentlyActive`	La session a été active récemment.
`kFlag_Suspended`	La session a été suspendue.

Attributs publics

AuthMode

WeaveAuthMode AuthMode

Moyen par lequel le nœud pair a été authentifié lors de l'établissement d'une session.

BoundCon

WeaveConnection * BoundCon

Connexion à laquelle la clé est liée.

Options

uint8_t Flags

Différents indicateurs associés à la session.

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

ID maximal du message reçu sous la clé de session.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

Clé de chiffrement des messages Weave.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

Identifiant de message suivant à utiliser sous la clé de session.

NodeId

uint64_t NodeId

Identifiant du nœud avec lequel la clé de session est partagée.

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

Indicateurs de suivi des messages reçus sous la clé.

ReserveCount

uint8_t ReserveCount

Nombre de fois où la clé de session a été réservée.

Fonctions publiques

Effacer

void Clear(
  void
)

Réinitialisez un objet WeaveSessionKey.

ClearRecentlyActive

void ClearRecentlyActive()

Indique que la session n'a PAS été active récemment.

ClearSuspended

void ClearSuspended()

Init

void Init(
  void
)

Initialisez un objet WeaveSessionKey.

IsAllocated

bool IsAllocated() const

Détails
Renvoie	"True" si l'objet WeaveSessionKey est alloué.

IsKeySet

bool IsKeySet() const

Détails
Renvoie	"True" si la valeur de la clé de chiffrement a été définie dans un objet WeaveSessionKey.

IsLocallyInitiated

bool IsLocallyInitiated() const

Détails
Renvoie	"True" si la session a été lancée par le nœud local.

IsRecentlyActive

bool IsRecentlyActive() const

Détails
Renvoie	"True" si la session a été active récemment.

IsRemoveOnIdle

bool IsRemoveOnIdle() const

Détails
Renvoie	"True" si la session est signalée pour suppression automatique en cas d'inactivité pendant un certain temps.

IsSharedSession

bool IsSharedSession() const

IsSuspended

bool IsSuspended() const

MarkRecentlyActive

void MarkRecentlyActive()

Indique que la session a été active récemment.

MarkSuspended

void MarkSuspended()

SetLocallyInitiated

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

Définit un indicateur indiquant si la session doit être automatiquement supprimée après une période d'inactivité.

Détails

Paramètres

[in] val

Valeur sur laquelle définir l'indicateur kFlag_IsRemoveOnIdle.

SetSharedSession

void SetSharedSession(
  bool val
)

Définit un indicateur indiquant si la session est une session partagée.

Détails

Paramètres

[in] val

Valeur sur laquelle définir l'option kFlag_IsSharedSession.