нл:: Переплетение:: WeaveSessionKey

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

Содержит информацию о сеансовом ключе Weave.

Краткое содержание

Публичные типы

FlagsEnum {
kFlag_IsLocallyInitiated = 0x01,
kFlag_IsSharedSession = 0x02,
kFlag_IsRemoveOnIdle = 0x04,
kFlag_RecentlyActive = 0x08,
kFlag_Suspended = 0x10
}		 перечисление

Публичные атрибуты

AuthMode
WeaveAuthMode
Способ, с помощью которого одноранговый узел был аутентифицирован во время установления сеанса.
BoundCon
Соединение, к которому привязан ключ.
Flags
uint8_t
Различные флаги, связанные с сеансом.
MaxRcvdMsgId
uint32_t
Максимальный идентификатор сообщения, полученного по сеансовому ключу.
MsgEncKey
Ключ шифрования сообщения Weave.
NextMsgId
Идентификатор следующего сообщения, который будет использоваться под сеансовым ключом.
NodeId
uint64_t
Идентификатор узла, с которым используется общий сеансовый ключ.
RcvFlags
WeaveSessionState::ReceiveFlagsType
Флаги отслеживания сообщений, полученных под ключом.
ReserveCount
uint8_t
Сколько раз сеансовый ключ был зарезервирован.

Общественные функции

Clear (void)
void
Сбросьте объект WeaveSessionKey .
ClearRecentlyActive ()
void
Сигнализирует о том, что сеанс НЕ был активен в недавнем прошлом.
ClearSuspended ()
void
Init (void)
void
Инициализируйте объект WeaveSessionKey .
IsAllocated () const
bool
IsKeySet () const
bool
IsLocallyInitiated () const
bool
IsRecentlyActive () const
bool
IsRemoveOnIdle () const
bool
IsSharedSession () const
bool
IsSuspended () const
bool
MarkRecentlyActive ()
void
Сигнализирует о том, что сеанс был активным в недавнем прошлом.
MarkSuspended ()
void
SetLocallyInitiated (bool val)
void
SetRemoveOnIdle (bool val)
void
Устанавливает флаг, указывающий, должен ли сеанс автоматически удаляться после периода простоя.
SetSharedSession (bool val)
void
Устанавливает флаг, указывающий, является ли сеанс общим.

Публичные типы

ФлагиEnum 

 FlagsEnum
Характеристики
kFlag_IsLocallyInitiated

Сеанс был инициирован локальным узлом.

kFlag_IsRemoveOnIdle

Сеанс следует удалять во время простоя (применяется только к сеансам, не привязанным к соединению).

kFlag_IsSharedSession

Сеанс является общим сеансом.

kFlag_RecentlyActive

Сессия недавно была активна.

kFlag_Suspended

Сессия приостановлена.

Публичные атрибуты

Режим аутентификации 

WeaveAuthMode AuthMode

Способ, с помощью которого одноранговый узел был аутентифицирован во время установления сеанса.

BoundCon 

WeaveConnection * BoundCon

Соединение, к которому привязан ключ.

Флаги 

uint8_t Flags

Различные флаги, связанные с сеансом.

МаксРквдмсгид 

uint32_t MaxRcvdMsgId

Максимальный идентификатор сообщения, полученного по сеансовому ключу.

Мсгенккей 

WeaveMsgEncryptionKey MsgEncKey

Ключ шифрования сообщения Weave.

СледующийMsgId 

MonotonicallyIncreasingCounter NextMsgId

Идентификатор следующего сообщения, который будет использоваться под сеансовым ключом.

идентификатор узла 

uint64_t NodeId

Идентификатор узла, с которым используется общий сеансовый ключ.

RcvFlags 

WeaveSessionState::ReceiveFlagsType RcvFlags

Флаги отслеживания сообщений, полученных под ключом.

РезервКаунт 

uint8_t ReserveCount

Сколько раз сеансовый ключ был зарезервирован.

Общественные функции

Прозрачный 

void Clear(
  void
)

Сбросьте объект WeaveSessionKey .

ОчиститьНедавноАктивный 

void ClearRecentlyActive()

Сигнализирует о том, что сеанс НЕ был активен в недавнем прошлом.

ОчиститьПриостановлено 

void ClearSuspended()

Инициализировать 

void Init(
  void
)

Инициализируйте объект WeaveSessionKey .

Исаллокатед 

bool IsAllocated() const

Подробности
Возврат
Истинно, если объект WeaveSessionKey выделен.

ИсКейСет 

bool IsKeySet() const

Подробности
Возврат
Истинно, если значение ключа шифрования установлено в объекте WeaveSessionKey .

IsLocallyInitiated 

bool IsLocallyInitiated() const

Подробности
Возврат
Истинно, если сеанс был инициирован локальным узлом.

IsRecentlyActive 

bool IsRecentlyActive() const

Подробности
Возврат
Истинно, если сеанс был активен в недавнем прошлом.

IsRemoveOnIdle 

bool IsRemoveOnIdle() const

Подробности
Возврат
Истинно, если сеанс помечен для автоматического удаления при простое в течение определенного периода времени.

Исшаредсессион 

bool IsSharedSession() const

IsSuspended 

bool IsSuspended() const

ОтметитьНедавноАктивный 

void MarkRecentlyActive()

Сигнализирует о том, что сеанс был активным в недавнем прошлом.

ОтметитьПриостановлено 

void MarkSuspended()

Установитьлокальноинициатеед 

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle 

void SetRemoveOnIdle(
  bool val
)

Устанавливает флаг, указывающий, должен ли сеанс автоматически удаляться после периода простоя.

Подробности
Параметры
[in] val
Значение, которому нужно установить флаг kFlag_IsRemoveOnIdle.

SetSharedSession 

void SetSharedSession(
  bool val
)

Устанавливает флаг, указывающий, является ли сеанс общим.

Подробности
Параметры
[in] val
Значение, которому нужно установить флаг kFlag_IsSharedSession.