nl:: Weave:: WeaveSessionKey
#include <src/lib/core/WeaveFabricState.h>
يحتوي على معلومات حول مفتاح جلسة Weave.
الملخّص
الأنواع المتاحة للجميع |
|
---|---|
FlagsEnum{
|
تعداد |
السمات العامة |
|
---|---|
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
وضع علامة تشير إلى ما إذا كانت الجلسة جلسة مشتركة
|
الأنواع المتاحة للجميع
الإبلاغ عن المحتوى
FlagsEnum
أماكن إقامة | |
---|---|
kFlag_IsLocallyInitiated
|
بدأت الجلسة بواسطة العقدة المحلية. |
kFlag_IsRemoveOnIdle
|
يجب إزالة الجلسة في حال عدم النشاط (لا تنطبق إلا على الجلسات غير المرتبطة بالاتصال). |
kFlag_IsSharedSession
|
الجلسة هي جلسة مشتركة. |
kFlag_RecentlyActive
|
كانت الجلسة نشطة مؤخرًا. |
kFlag_Suspended
|
تم تعليق الجلسة. |
السمات العامة
وضع المصادقة
WeaveAuthMode AuthMode
الوسائل التي تم من خلالها مصادقة عقدة الزملاء أثناء إنشاء الجلسة.
الأعلام
uint8_t Flags
علامات مختلفة مرتبطة بالجلسة.
MaxRcvdMsgId
uint32_t MaxRcvdMsgId
الحد الأقصى لرقم تعريف الرسالة الذي تم استلامه ضمن مفتاح الجلسة.
رقم تعريف الرسالة التالية
MonotonicallyIncreasingCounter NextMsgId
رقم تعريف الرسالة التالية المطلوب استخدامه ضمن مفتاح الجلسة.
الرقم التعريفي للعقدة
uint64_t NodeId
رقم تعريف العقدة التي تتم مشاركة مفتاح الجلسة معها.
علامات RcvFlags
WeaveSessionState::ReceiveFlagsType RcvFlags
الإبلاغ عن رسائل التتبُّع التي تم تلقيها ضمن المفتاح.
عدد الكيانات المحجوزة
uint8_t ReserveCount
عدد مرات حجز مفتاح الجلسة.
وظائف عامة
ClearClearActive
void ClearRecentlyActive()
يشير إلى أن الجلسة لم تكن نشطة في الماضي الأخير.
محو التعليق
void ClearSuspended()
مجموعة رموز المفاتيح
bool IsKeySet() const
التفاصيل | |
---|---|
المرتجعات |
صحيح إذا تم ضبط قيمة مفتاح التشفير في كائن WeaveSessionKey.
|
تم البدء محليًا
bool IsLocallyInitiated() const
التفاصيل | |
---|---|
المرتجعات |
صحيح إذا بدأت الجلسة بواسطة العقدة المحلية.
|
نشط مؤخرًا
bool IsRecentlyActive() const
التفاصيل | |
---|---|
المرتجعات |
صحيح إذا كانت الجلسة نشطة في الماضي الأخير.
|
IsRemoveOnIdle
bool IsRemoveOnIdle() const
التفاصيل | |
---|---|
المرتجعات |
صحيح إذا تم وضع علامة على الجلسة لإزالتها تلقائيًا عندما تكون غير نشطة لفترة من الوقت.
|
جلسة مشتركة
bool IsSharedSession() const
معلّق
bool IsSuspended() const
وضع علامة نشطة مؤخرًا
void MarkRecentlyActive()
يشير إلى أن الجلسة كانت نشطة في الماضي الأخير.
وضع علامة على التعليق
void MarkSuspended()
تم الإعداد محليًا
void SetLocallyInitiated( bool val )
ضبط إزالة على معرف
void SetRemoveOnIdle( bool val )
وضع علامة تشير إلى ما إذا كان يجب إزالة الجلسة تلقائيًا بعد فترة عدم نشاط
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
ضبط الجلسة المشتركة
void SetSharedSession( bool val )
وضع علامة تشير إلى ما إذا كانت الجلسة جلسة مشتركة
التفاصيل | |||
---|---|---|---|
المعلَمات |
|