nl::Weave::WeaveSessionKey

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

Weave oturum anahtarıyla ilgili bilgileri içerir.

Özet

Herkese açık türler

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

Herkese açık özellikler

AuthMode
WeaveAuthMode
Oturum oluşturma sırasında eş düğümün kimliğinin doğrulanması için kullanılan yöntem.
BoundCon
Anahtarın bağlı olduğu bağlantı.
Flags
uint8_t
Oturumla ilişkilendirilen çeşitli işaretler.
MaxRcvdMsgId
uint32_t
Oturum anahtarı altında alınan maksimum mesaj kimliği.
MsgEncKey
Weave mesaj şifreleme anahtarı.
NextMsgId
Oturum anahtarı altında kullanılacak sonraki mesaj kimliği.
NodeId
uint64_t
Oturum anahtarının paylaşıldığı düğümün kimliği.
RcvFlags
WeaveSessionState::ReceiveFlagsType
Anahtar altında alınan izleme iletilerini işaretler.
ReserveCount
uint8_t
Oturum anahtarının ayrılma sayısı.

Kamu işlevleri

Clear(void)
void
Bir WeaveSessionKey nesnesini sıfırlayın.
ClearRecentlyActive()
void
Oturumun yakın zamanda etkin OLMADIĞINI belirtir.
ClearSuspended()
void
Init(void)
void
Bir WeaveSessionKey nesnesini başlatın.
IsAllocated() const
bool
IsKeySet() const
bool
IsLocallyInitiated() const
bool
IsRecentlyActive() const
bool
IsRemoveOnIdle() const
bool
IsSharedSession() const
bool
IsSuspended() const
bool
MarkRecentlyActive()
void
Oturumun yakın zamanda etkin olduğunu gösterir.
MarkSuspended()
void
SetLocallyInitiated(bool val)
void
SetRemoveOnIdle(bool val)
void
Oturumun belirli bir süre boşta kalma süresinden sonra otomatik olarak kaldırılması gerekip gerekmediğini belirten bir işaret ayarlar.
SetSharedSession(bool val)
void
Oturumun paylaşılan bir oturum olup olmadığını gösteren bir işaret ayarlar.

Herkese açık türler

FlagsEnum

 FlagsEnum
Özellikler
kFlag_IsLocallyInitiated

Oturum, yerel düğüm tarafından başlatıldı.

kFlag_IsRemoveOnIdle

Boştayken oturum kaldırılmalıdır (yalnızca bir bağlantıya bağlı olmayan oturumlar için geçerlidir).

kFlag_IsSharedSession

Bu oturum, paylaşılan bir oturumdur.

kFlag_RecentlyActive

Oturum yakın zamanda etkindi.

kFlag_Suspended

Oturum askıya alındı.

Herkese açık özellikler

AuthMode

WeaveAuthMode AuthMode

Oturum oluşturma sırasında eş düğümün kimliğinin doğrulanması için kullanılan yöntem.

BoundCon

WeaveConnection * BoundCon

Anahtarın bağlı olduğu bağlantı.

Bayraklar

uint8_t Flags

Oturumla ilişkilendirilen çeşitli işaretler.

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

Oturum anahtarı altında alınan maksimum mesaj kimliği.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

Weave mesaj şifreleme anahtarı.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

Oturum anahtarı altında kullanılacak sonraki mesaj kimliği.

NodeId

uint64_t NodeId

Oturum anahtarının paylaşıldığı düğümün kimliği.

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

Anahtar altında alınan izleme iletilerini işaretler.

ReserveCount

uint8_t ReserveCount

Oturum anahtarının ayrılma sayısı.

Kamu işlevleri

Temizle

void Clear(
  void
)

Bir WeaveSessionKey nesnesini sıfırlayın.

ClearRecentlyActive

void ClearRecentlyActive()

Oturumun yakın zamanda etkin OLMADIĞINI belirtir.

ClearSuspended

void ClearSuspended()

Başlat

void Init(
  void
)

Bir WeaveSessionKey nesnesini başlatın.

IsAllocated

bool IsAllocated() const 

Ayrıntılar
İadeler
WeaveSessionKey nesnesi ayrılmışsa doğru değerini alır.

IsKeySet

bool IsKeySet() const 

Ayrıntılar
İadeler
Şifreleme anahtarı değeri bir WeaveSessionKey nesnesinde ayarlanmışsa doğru değerini alır.

IsLocallyInitiated

bool IsLocallyInitiated() const 

Ayrıntılar
İadeler
Oturum yerel düğüm tarafından başlatıldıysa doğru değerini alır.

IsRecentlyActive

bool IsRecentlyActive() const 

Ayrıntılar
İadeler
Oturum yakın geçmişte etkin olduysa doğru değerini döndürür.

IsRemoveOnIdle

bool IsRemoveOnIdle() const 

Ayrıntılar
İadeler
Oturum, belirli bir süre boşta kaldığında otomatik olarak kaldırılmak üzere işaretlenmişse doğru değerini alır.

IsSharedSession

bool IsSharedSession() const 

IsSuspended

bool IsSuspended() const 

MarkRecentlyActive

void MarkRecentlyActive()

Oturumun yakın zamanda etkin olduğunu gösterir.

MarkSuspended

void MarkSuspended()

SetLocallyInitiated

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

Oturumun belirli bir süre boşta kalma süresinden sonra otomatik olarak kaldırılması gerekip gerekmediğini belirten bir işaret ayarlar.

Ayrıntılar
Parametreler
[in] val
kFlag_IsRemoveOnIdle işaretinin ayarlanacağı değer.

SetSharedSession

void SetSharedSession(
  bool val
)

Oturumun paylaşılan bir oturum olup olmadığını gösteren bir işaret ayarlar.

Ayrıntılar
Parametreler
[in] val
kFlag_IsSharedSession işaretinin ayarlanacağı değer.