nl:: WeaveSessionKey: WeaveSessionKey
#include <src/lib/core/WeaveFabricState.h>
Weave oturum anahtarı hakkında bilgiler içerir.
Özet
Herkese açık türler |
|
---|---|
FlagsEnum{
|
enum |
Herkese açık özellikler |
|
---|---|
AuthMode
|
WeaveAuthMode
Oturum oluştururken benzerler düğümünün kimlik doğrulama yöntemi.
|
BoundCon
|
Anahtarın bağlı olduğu bağlantı.
|
Flags
|
uint8_t
Oturumla ilişkili çeşitli işaretler.
|
MaxRcvdMsgId
|
uint32_t
Oturum anahtarı altında alınan maksimum ileti kimliği.
|
MsgEncKey
|
Weave mesaj şifreleme anahtarı.
|
NextMsgId
|
Oturum anahtarının 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 iletileri izleyen işaretleri.
|
ReserveCount
|
uint8_t
Oturum anahtarının ayrılma sayısı.
|
Herkese açık işlevler |
|
---|---|
Clear(void)
|
void
Bir WeaveSessionKey nesnesini sıfırlayın.
|
ClearRecentlyActive()
|
void
Oturumun, yakın zamanda etkin olmadığı anlamına gelir.
|
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 belirtir.
|
MarkSuspended()
|
void
|
SetLocallyInitiated(bool val)
|
void
|
SetRemoveOnIdle(bool val)
|
void
Boşta kalma süresi sonunda oturumun 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 belirler.
|
Herkese açık türler
BayraklarEnum
FlagsEnum
Özellikler | |
---|---|
kFlag_IsLocallyInitiated
|
Oturum, yerel düğüm tarafından başlatıldı. |
kFlag_IsRemoveOnIdle
|
Oturum boşta olduğunda kaldırılmalıdır (yalnızca 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
|
Bu oturum askıya alındı. |
Herkese açık özellikler
Kimlik Doğrulama Modu
WeaveAuthMode AuthMode
Oturum oluştururken benzerler düğümünün kimlik doğrulama yöntemi.
İşaretler
uint8_t Flags
Oturumla ilişkili çeşitli işaretler.
MaksRcvdMsgId
uint32_t MaxRcvdMsgId
Oturum anahtarı altında alınan maksimum ileti kimliği.
NextMsgId
MonotonicallyIncreasingCounter NextMsgId
Oturum anahtarının altında kullanılacak sonraki mesaj kimliği.
Düğüm kimliği
uint64_t NodeId
Oturum anahtarının paylaşıldığı düğümün kimliği.
Rcvİşaretleri
WeaveSessionState::ReceiveFlagsType RcvFlags
Anahtar altında alınan iletileri izleyen işaretleri.
ReserveCount
uint8_t ReserveCount
Oturum anahtarının ayrılma sayısı.
Herkese açık işlevler
ClearRecent
void ClearRecentlyActive()
Oturumun, yakın zamanda etkin olmadığı anlamına gelir.
ClearSuspended
void ClearSuspended()
Ayrılan
bool IsAllocated() const
Ayrıntılar | |
---|---|
İadeler |
WeaveSessionKey nesnesi ayrılırsa true değerini alır.
|
IsKeySet (IsKeySet)
bool IsKeySet() const
Ayrıntılar | |
---|---|
İadeler |
Şifreleme anahtarı değeri bir WeaveSessionKey nesnesinde ayarlanmışsa doğrudur.
|
Yerel Olarak Başlatılan
bool IsLocallyInitiated() const
Ayrıntılar | |
---|---|
İadeler |
Oturum, yerel düğüm tarafından başlatıldıysa true değerini alır.
|
Son Etkin Olanlar
bool IsRecentlyActive() const
Ayrıntılar | |
---|---|
İadeler |
Oturum yakın zamanda etkinse doğru değerini alır.
|
IsRemoveOnIdle değeri
bool IsRemoveOnIdle() const
Ayrıntılar | |
---|---|
İadeler |
Oturum belirli bir süre boşta kaldığında oturum otomatik kaldırma için işaretlendiyse true değerini alır.
|
Paylaşılan Oturum
bool IsSharedSession() const
Askıya Alındı
bool IsSuspended() const
Son zamanlarda Etkin
void MarkRecentlyActive()
Oturumun yakın zamanda etkin olduğunu belirtir.
Askıya Alınmış
void MarkSuspended()
SetLocallyBaşlatılan
void SetLocallyInitiated( bool val )
SetRemoveOnIdle
void SetRemoveOnIdle( bool val )
Boşta kalma süresi sonunda oturumun otomatik olarak kaldırılması gerekip gerekmediğini belirten bir işaret ayarlar.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
Paylaşılan Oturum
void SetSharedSession( bool val )
Oturumun paylaşılan bir oturum olup olmadığını gösteren bir işaret belirler.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|