nl::Weave::WeaveSessionKey

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

Contiene información sobre una clave de sesión de Weave.

Resumen

Tipos públicos

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

Atributos públicos

AuthMode
WeaveAuthMode
El medio por el que se autenticó el nodo de intercambio de tráfico durante el establecimiento de la sesión.
BoundCon
La conexión a la que está vinculada la clave.
Flags
uint8_t
Varias marcas asociadas con la sesión
MaxRcvdMsgId
uint32_t
El ID máximo de mensaje recibido con la clave de sesión.
MsgEncKey
La clave de encriptación de mensajes de Weave.
NextMsgId
El siguiente ID de mensaje que se usará bajo la clave de sesión.
NodeId
uint64_t
Es el ID del nodo con el que se comparte la clave de sesión.
RcvFlags
WeaveSessionState::ReceiveFlagsType
Marcas de seguimiento de mensajes recibidos con la clave
ReserveCount
uint8_t
Cantidad de veces que se reservó la clave de sesión.

Funciones públicas

Clear(void)
void
Restablece un objeto WeaveSessionKey.
ClearRecentlyActive()
void
Indica que la sesión NO estuvo activa recientemente.
ClearSuspended()
void
Init(void)
void
Inicializa un objeto 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 que la sesión estuvo activa recientemente.
MarkSuspended()
void
SetLocallyInitiated(bool val)
void
SetRemoveOnIdle(bool val)
void
Establece una marca que indica si la sesión se debe quitar automáticamente después de un período de inactividad.
SetSharedSession(bool val)
void
Establece una marca que indica si la sesión es compartida.

Tipos públicos

FlagsEnum

 FlagsEnum
Propiedades
kFlag_IsLocallyInitiated

El nodo local inició la sesión.

kFlag_IsRemoveOnIdle

Se debe quitar la sesión cuando está inactiva (solo se aplica a las sesiones que no están vinculadas a una conexión).

kFlag_IsSharedSession

La sesión es compartida.

kFlag_RecentlyActive

La sesión estuvo activa recientemente.

kFlag_Suspended

Se suspendió la sesión.

Atributos públicos

AuthMode

WeaveAuthMode AuthMode

El medio por el que se autenticó el nodo de intercambio de tráfico durante el establecimiento de la sesión.

BoundCon

WeaveConnection * BoundCon

La conexión a la que está vinculada la clave.

Marcas

uint8_t Flags

Varias marcas asociadas con la sesión

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

El ID máximo de mensaje recibido con la clave de sesión.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

La clave de encriptación de mensajes de Weave.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

El siguiente ID de mensaje que se usará bajo la clave de sesión.

NodeId

uint64_t NodeId

Es el ID del nodo con el que se comparte la clave de sesión.

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

Marcas de seguimiento de mensajes recibidos con la clave

ReserveCount

uint8_t ReserveCount

Cantidad de veces que se reservó la clave de sesión.

Funciones públicas

Borrar

void Clear(
  void
)

Restablece un objeto WeaveSessionKey.

ClearRecentlyActive

void ClearRecentlyActive()

Indica que la sesión NO estuvo activa recientemente.

ClearSuspended

void ClearSuspended()

Init

void Init(
  void
)

Inicializa un objeto WeaveSessionKey.

IsAllocated

bool IsAllocated() const 

Detalles
Qué muestra
Es verdadero si el objeto WeaveSessionKey está asignado.

IsKeySet

bool IsKeySet() const 

Detalles
Qué muestra
Es verdadero si el valor de la clave de encriptación se estableció en un objeto WeaveSessionKey.

IsLocallyInitiated

bool IsLocallyInitiated() const 

Detalles
Qué muestra
Es verdadero si el nodo local inició la sesión.

IsRecentlyActive

bool IsRecentlyActive() const 

Detalles
Qué muestra
Es verdadero si la sesión estuvo activa recientemente.

IsRemoveOnIdle

bool IsRemoveOnIdle() const 

Detalles
Qué muestra
Es verdadero si se marca la sesión para su eliminación automática cuando está inactiva durante un período de tiempo.

IsSharedSession

bool IsSharedSession() const 

IsSuspended

bool IsSuspended() const 

MarkRecentlyActive

void MarkRecentlyActive()

Indica que la sesión estuvo activa recientemente.

MarkSuspended

void MarkSuspended()

SetLocallyInitiated

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

Establece una marca que indica si la sesión se debe quitar automáticamente después de un período de inactividad.

Detalles
Parámetros
[in] val
El valor en el que se establece la marca kFlag_IsRemoveOnIdle.

SetSharedSession

void SetSharedSession(
  bool val
)

Establece una marca que indica si la sesión es compartida.

Detalles
Parámetros
[in] val
El valor en el que se establece la marca kFlag_IsSharedSession.