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{
|
enum |
Atributos públicos |
|
---|---|
AuthMode
|
WeaveAuthMode
Es el medio por el que se autenticó el nodo del par 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 del 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á en la clave de sesión.
|
NodeId
|
uint64_t
El ID del nodo con el que se comparte la clave de sesión.
|
RcvFlags
|
WeaveSessionState::ReceiveFlagsType
Marcas que registran los mensajes recibidos debajo de 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 en el pasado reciente.
|
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 en el pasado reciente.
|
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 una sesión compartida.
|
Tipos públicos
EnmarcadoEnum
FlagsEnum
Properties | |
---|---|
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
|
Esta es una sesión compartida. |
kFlag_RecentlyActive
|
La sesión estuvo activa recientemente. |
kFlag_Suspended
|
Se suspendió la sesión. |
Atributos públicos
Modo de autenticación
WeaveAuthMode AuthMode
Es el medio por el que se autenticó el nodo del par durante el establecimiento de la sesión.
Marcas
uint8_t Flags
Varias marcas asociadas con la sesión.
ID de la campaña de máximo rendimiento
uint32_t MaxRcvdMsgId
El ID máximo del mensaje recibido con la clave de sesión.
ID de mensaje siguiente
MonotonicallyIncreasingCounter NextMsgId
El siguiente ID de mensaje que se usará en la clave de sesión.
ID del nodo
uint64_t NodeId
El ID del nodo con el que se comparte la clave de sesión.
CVR
WeaveSessionState::ReceiveFlagsType RcvFlags
Marcas que registran los mensajes recibidos debajo de la clave.
Recuento de reservas
uint8_t ReserveCount
Cantidad de veces que se reservó la clave de sesión.
Funciones públicas
ClearRecentlyActive.
void ClearRecentlyActive()
Indica que la sesión NO estuvo activa en el pasado reciente.
Borrar suspensión
void ClearSuspended()
Asignada
bool IsAllocated() const
Detalles | |
---|---|
Qué muestra |
Verdadero si se asigna el objeto WeaveSessionKey.
|
Conjunto de claves
bool IsKeySet() const
Detalles | |
---|---|
Qué muestra |
Verdadero si el valor de la clave de encriptación se estableció en un objeto WeaveSessionKey.
|
Iniciado de manera local
bool IsLocallyInitiated() const
Detalles | |
---|---|
Qué muestra |
Se asigna el valor true si el nodo local inició la sesión.
|
Recientemente activo
bool IsRecentlyActive() const
Detalles | |
---|---|
Qué muestra |
Se asigna el valor true si la sesión estuvo activa en el pasado reciente.
|
IsRemoveOnIdle.
bool IsRemoveOnIdle() const
Detalles | |
---|---|
Qué muestra |
Se asigna el valor true si la sesión se marca para su eliminación automática cuando está inactiva durante un período.
|
IsSharedSession
bool IsSharedSession() const
Está suspendido
bool IsSuspended() const
Recientemente marcados
void MarkRecentlyActive()
Indica que la sesión estuvo activa en el pasado reciente.
Marcar como suspendido
void MarkSuspended()
Iniciado de manera local
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 |
|
SetSharedSession
void SetSharedSession( bool val )
Establece una marca que indica si la sesión es una sesión compartida.
Detalles | |||
---|---|---|---|
Parámetros |
|