nl::Weave::WeaveSessionKey

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

Contém informações sobre uma chave de sessão do Weave.

Resumo

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
O meio pelo qual o nó de peering foi autenticado durante o estabelecimento da sessão.
BoundCon
A conexão a que a chave está vinculada.
Flags
uint8_t
Várias sinalizações associadas à sessão.
MaxRcvdMsgId
uint32_t
O código máximo da mensagem recebido sob a chave de sessão.
MsgEncKey
A chave de criptografia de mensagens do Weave.
NextMsgId
O ID da próxima mensagem a ser usado na chave de sessão.
NodeId
uint64_t
ID do nó com que a chave de sessão é compartilhada.
RcvFlags
WeaveSessionState::ReceiveFlagsType
Sinalizações que rastreiam mensagens recebidas sob a chave.
ReserveCount
uint8_t
Número de vezes que a chave de sessão foi reservada.

Funções públicas

Clear(void)
void
Redefine um objeto WeaveSessionKey.
ClearRecentlyActive()
void
Sinaliza a sessão como NÃO esteve ativa no passado recente.
ClearSuspended()
void
Init(void)
void
Inicialize um 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
Sinaliza a sessão como ativa no passado recente.
MarkSuspended()
void
SetLocallyInitiated(bool val)
void
SetRemoveOnIdle(bool val)
void
Define um sinalizador que indica se a sessão deve ser removida automaticamente após um período de inatividade.
SetSharedSession(bool val)
void
Define uma sinalização que indica se a sessão é compartilhada.

Tipos públicos

FlagsEnum

 FlagsEnum
Propriedades
kFlag_IsLocallyInitiated

A sessão foi iniciada pelo nó local.

kFlag_IsRemoveOnIdle

A sessão precisa ser removida quando estiver inativa (aplicável somente a sessões que não estão vinculadas a uma conexão).

kFlag_IsSharedSession

A sessão é compartilhada.

kFlag_RecentlyActive

A sessão foi ativa recentemente.

kFlag_Suspended

A sessão foi suspensa.

Atributos públicos

AuthMode

WeaveAuthMode AuthMode

O meio pelo qual o nó de peering foi autenticado durante o estabelecimento da sessão.

BoundCon

WeaveConnection * BoundCon

A conexão a que a chave está vinculada.

Sinalizações

uint8_t Flags

Várias sinalizações associadas à sessão.

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

O código máximo da mensagem recebido sob a chave de sessão.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

A chave de criptografia de mensagens do Weave.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

O ID da próxima mensagem a ser usado na chave de sessão.

NodeId

uint64_t NodeId

ID do nó com que a chave de sessão é compartilhada.

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

Sinalizações que rastreiam mensagens recebidas sob a chave.

ReserveCount

uint8_t ReserveCount

Número de vezes que a chave de sessão foi reservada.

Funções públicas

Limpar

void Clear(
  void
)

Redefine um objeto WeaveSessionKey.

ClearRecentlyActive

void ClearRecentlyActive()

Sinaliza a sessão como NÃO esteve ativa no passado recente.

ClearSuspended

void ClearSuspended()

Init

void Init(
  void
)

Inicialize um objeto WeaveSessionKey.

IsAllocated

bool IsAllocated() const 

Detalhes
Retornos
Verdadeiro se o objeto WeaveSessionKey estiver alocado.

IsKeySet

bool IsKeySet() const 

Detalhes
Retornos
Verdadeiro se o valor da chave de criptografia tiver sido definido em um objeto WeaveSessionKey.

IsLocallyInitiated

bool IsLocallyInitiated() const 

Detalhes
Retornos
Verdadeiro se a sessão tiver sido iniciada pelo nó local.

IsRecentlyActive

bool IsRecentlyActive() const 

Detalhes
Retornos
Verdadeiro se a sessão esteve ativa recentemente.

IsRemoveOnIdle

bool IsRemoveOnIdle() const 

Detalhes
Retornos
Verdadeiro se a sessão for sinalizada para remoção automática quando ficar inativa por um período.

IsSharedSession

bool IsSharedSession() const 

IsSuspended

bool IsSuspended() const 

MarkRecentlyActive

void MarkRecentlyActive()

Sinaliza a sessão como ativa no passado recente.

MarkSuspended

void MarkSuspended()

SetLocallyInitiated

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

Define um sinalizador que indica se a sessão deve ser removida automaticamente após um período de inatividade.

Detalhes
Parâmetros
[in] val
O valor para definir o flag kFlag_IsRemoveOnIdle.

SetSharedSession

void SetSharedSession(
  bool val
)

Define uma sinalização que indica se a sessão é compartilhada.

Detalhes
Parâmetros
[in] val
O valor a ser definido para a sinalização kFlag_IsSharedSession.