nl::Weave::WeaveSessionKey

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

Contiene informazioni su una chiave di sessione Weave.

Riepilogo

Tipi pubblici

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

Attributi pubblici

AuthMode
WeaveAuthMode
Il metodo mediante il quale il nodo peer è stato autenticato durante la creazione della sessione.
BoundCon
La connessione a cui è associata la chiave.
Flags
uint8_t
Diversi flag associati alla sessione.
MaxRcvdMsgId
uint32_t
L'ID massimo del messaggio ricevuto con la chiave di sessione.
MsgEncKey
La chiave di crittografia del messaggio Weave.
NextMsgId
L'ID messaggio successivo da utilizzare nella chiave di sessione.
NodeId
uint64_t
L'ID del nodo con cui è condivisa la chiave di sessione.
RcvFlags
WeaveSessionState::ReceiveFlagsType
Segnala i messaggi di monitoraggio ricevuti con la chiave.
ReserveCount
uint8_t
Numero di volte in cui la chiave di sessione è stata prenotata.

Funzioni pubbliche

Clear(void)
void
Reimposta un oggetto WeaveSessionKey.
ClearRecentlyActive()
void
Indica che la sessione NON è stata attiva nel recente passato.
ClearSuspended()
void
Init(void)
void
Inizializza un oggetto WeaveSessionKey.
IsAllocated() const
bool
IsKeySet() const
bool
IsLocallyInitiated() const
bool
IsRecentlyActive() const
bool
IsRemoveOnIdle() const
bool
IsSharedSession() const
bool
IsSuspended() const
bool
MarkRecentlyActive()
void
Indica che la sessione è stata attiva nel recente passato.
MarkSuspended()
void
SetLocallyInitiated(bool val)
void
SetRemoveOnIdle(bool val)
void
Imposta un flag che indica se la sessione deve essere rimossa automaticamente dopo un periodo di inattività.
SetSharedSession(bool val)
void
Imposta un flag che indica se la sessione è condivisa.

Tipi pubblici

FlagsEnum

 FlagsEnum
Proprietà
kFlag_IsLocallyInitiated

La sessione è stata avviata dal nodo locale.

kFlag_IsRemoveOnIdle

La sessione deve essere rimossa quando inattiva (si applica solo alle sessioni che non sono associate a una connessione).

kFlag_IsSharedSession

La sessione è condivisa.

kFlag_RecentlyActive

La sessione è stata attiva di recente.

kFlag_Suspended

La sessione è stata sospesa.

Attributi pubblici

AuthMode

WeaveAuthMode AuthMode

Il metodo mediante il quale il nodo peer è stato autenticato durante la creazione della sessione.

BoundCon

WeaveConnection * BoundCon

La connessione a cui è associata la chiave.

Bandiere

uint8_t Flags

Diversi flag associati alla sessione.

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

L'ID massimo del messaggio ricevuto con la chiave di sessione.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

La chiave di crittografia del messaggio Weave.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

L'ID messaggio successivo da utilizzare nella chiave di sessione.

NodeId

uint64_t NodeId

L'ID del nodo con cui è condivisa la chiave di sessione.

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

Segnala i messaggi di monitoraggio ricevuti con la chiave.

ReserveCount

uint8_t ReserveCount

Numero di volte in cui la chiave di sessione è stata prenotata.

Funzioni pubbliche

Cancella

void Clear(
  void
)

Reimposta un oggetto WeaveSessionKey.

ClearRecentlyActive

void ClearRecentlyActive()

Indica che la sessione NON è stata attiva nel recente passato.

ClearSuspended

void ClearSuspended()

Init

void Init(
  void
)

Inizializza un oggetto WeaveSessionKey.

IsAllocated

bool IsAllocated() const 

Dettagli
Restituisce
True se viene allocato l'oggetto WeaveSessionKey.

IsKeySet

bool IsKeySet() const 

Dettagli
Restituisce
True se il valore della chiave di crittografia è stato impostato in un oggetto WeaveSessionKey.

IsLocallyInitiated

bool IsLocallyInitiated() const 

Dettagli
Restituisce
True se la sessione è stata avviata dal nodo locale.

IsRecentlyActive

bool IsRecentlyActive() const 

Dettagli
Restituisce
True se la sessione è stata attiva di recente.

IsRemoveOnIdle

bool IsRemoveOnIdle() const 

Dettagli
Restituisce
True se la sessione è contrassegnata per la rimozione automatica quando rimane inattiva per un determinato periodo di tempo.

IsSharedSession

bool IsSharedSession() const 

IsSuspended

bool IsSuspended() const 

MarkRecentlyActive

void MarkRecentlyActive()

Indica che la sessione è stata attiva nel recente passato.

MarkSuspended

void MarkSuspended()

SetLocallyInitiated

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

Imposta un flag che indica se la sessione deve essere rimossa automaticamente dopo un periodo di inattività.

Dettagli
Parametri
[in] val
Il valore su cui impostare il flag kFlag_IsRemoveOnIdle.

SetSharedSession

void SetSharedSession(
  bool val
)

Imposta un flag che indica se la sessione è condivisa.

Dettagli
Parametri
[in] val
Il valore su cui impostare il flag kFlag_IsSharedSession.