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 de 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
Es el ID máximo del mensaje recibido según la clave de sesión.
|
MsgEncKey
|
La clave de encriptación de mensajes de Weave.
|
NextMsgId
|
Es el siguiente ID de mensaje que se usará debajo de 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
Marca los mensajes de seguimiento que se recibieron 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 ha estado 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
FlagsEnum
FlagsEnum
Propiedades | |
---|---|
kFlag_IsLocallyInitiated
|
El nodo local inició la sesión. |
kFlag_IsRemoveOnIdle
|
La sesión se debe quitar 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 se activó recientemente. |
kFlag_Suspended
|
Se suspendió la sesión. |
Atributos públicos
AuthMode
WeaveAuthMode AuthMode
Es el medio por el que se autenticó el nodo de par durante el establecimiento de la sesión.
Marcas
uint8_t Flags
Varias marcas asociadas con la sesión.
MaxRcvdMsgId
uint32_t MaxRcvdMsgId
Es el ID máximo del mensaje recibido según la clave de sesión.
NextMsgId
MonotonicallyIncreasingCounter NextMsgId
Es el siguiente ID de mensaje que se usará debajo de 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
Marca los mensajes de seguimiento que se recibieron con la clave.
ReserveCount
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 ha estado activa en el pasado reciente.
ClearSuspended
void ClearSuspended()
IsAllocated
bool IsAllocated() const
Detalles | |
---|---|
Resultado que se muestra |
Es verdadero si el objeto WeaveSessionKey está asignado.
|
IsKeySet
bool IsKeySet() const
Detalles | |
---|---|
Resultado que se muestra |
Es verdadero si el valor de la clave de encriptación se estableció en un objeto WeaveSessionKey.
|
IsLocallyInitiated
bool IsLocallyInitiated() const
Detalles | |
---|---|
Resultado que se muestra |
Es verdadero si el nodo local inició la sesión.
|
IsRecentlyActive
bool IsRecentlyActive() const
Detalles | |
---|---|
Resultado que se muestra |
Es verdadero si la sesión estuvo activa en el pasado reciente.
|
IsRemoveOnIdle
bool IsRemoveOnIdle() const
Detalles | |
---|---|
Resultado que se muestra |
Es verdadero si la sesión se marca para quitarse automáticamente cuando está inactiva durante un período.
|
IsSharedSession
bool IsSharedSession() const
IsSuspended
bool IsSuspended() const
MarkRecentlyActive
void MarkRecentlyActive()
Indica que la sesión estuvo activa en el pasado reciente.
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 |
|
SetSharedSession
void SetSharedSession( bool val )
Establece una marca que indica si la sesión es una sesión compartida.
Detalles | |||
---|---|---|---|
Parámetros |
|