nl::Weave::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
يضع علامة تشير إلى ما إذا كانت الجلسة جلسة مشتركة أم لا.

الأنواع العلنية

FlagsEnum

 FlagsEnum
أماكن إقامة
kFlag_IsLocallyInitiated

تم بدء الجلسة من قِبل العقدة المحلية.

kFlag_IsRemoveOnIdle

يجب إزالة الجلسة عندما تكون في وضع عدم النشاط (لا ينطبق ذلك إلا على الجلسات غير المرتبطة باتصال).

kFlag_IsSharedSession

الجلسة هي جلسة مشتركة.

kFlag_RecentlyActive

كانت الجلسة نشطة مؤخرًا.

kFlag_Suspended

تم تعليق الجلسة.

السمات العامة

AuthMode

WeaveAuthMode AuthMode

هي الوسيلة التي تمت بها مصادقة عقدة النظراء أثناء إنشاء الجلسة.

BoundCon

WeaveConnection * BoundCon

تشير هذه السمة إلى الاتصال الذي يرتبط به المفتاح.

أعلام

uint8_t Flags

علامات مختلفة مرتبطة بالجلسة

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

الحد الأقصى لمعرّف الرسالة التي تم استلامها ضمن مفتاح الجلسة.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

مفتاح تشفير رسالة Weave.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

رقم تعريف الرسالة التالي الذي سيتم استخدامه ضمن مفتاح الجلسة.

NodeId

uint64_t NodeId

رقم تعريف العقدة التي تتم مشاركة مفتاح الجلسة معها.

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

يضع علامات على رسائل تتبع الرسائل التي يتم استلامها ضمن المفتاح.

ReserveCount

uint8_t ReserveCount

عدد مرات حجز مفتاح الجلسة.

الدوال العامة

محو

void Clear(
  void
)

إعادة ضبط كائن WeaveSessionKey.

ClearRecentlyActive

void ClearRecentlyActive()

يشير إلى أن الجلسة لم تكن نشطة في الماضي القريب.

ClearSuspended

void ClearSuspended()

إنت

void Init(
  void
)

ابدأ تشغيل كائن WeaveSessionKey.

IsAllocated

bool IsAllocated() const 

التفاصيل
المرتجعات
صحيح إذا تم تخصيص الكائن WeaveSessionKey.

IsKeySet

bool IsKeySet() const 

التفاصيل
المرتجعات
صحيح إذا تم ضبط قيمة مفتاح التشفير في كائن WeaveSessionKey.

IsLocallyInitiated

bool IsLocallyInitiated() const 

التفاصيل
المرتجعات
True إذا تم بدء الجلسة بواسطة عقدة محلية.

IsRecentlyActive

bool IsRecentlyActive() const 

التفاصيل
المرتجعات
صحيح إذا كانت الجلسة نشطة في الماضي.

IsRemoveOnIdle

bool IsRemoveOnIdle() const 

التفاصيل
المرتجعات
صحيح إذا تم وضع علامة على الجلسة لإزالتها تلقائيًا عندما تكون غير نشطة لفترة من الوقت.

IsSharedSession

bool IsSharedSession() const 

IsSuspended

bool IsSuspended() const 

MarkRecentlyActive

void MarkRecentlyActive()

يشير إلى أنّ الجلسة كانت نشطة في الماضي القريب.

MarkSuspended

void MarkSuspended()

SetLocallyInitiated

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

يضع علامة تشير إلى ما إذا كان يجب إزالة الجلسة تلقائيًا بعد فترة من عدم النشاط.

التفاصيل
المَعلمات
[in] val
القيمة لضبط العلامة kFlag_IsRemoveOnIdle عليها

SetSharedSession

void SetSharedSession(
  bool val
)

يضع علامة تشير إلى ما إذا كانت الجلسة جلسة مشتركة أم لا.

التفاصيل
المَعلمات
[in] val
القيمة المطلوب ضبط العلامة kFlag_IsSharedSession عليها.