تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

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`	`WeaveConnection *` يشير ذلك المصطلح إلى الاتصال الذي يرتبط به المفتاح.
`Flags`	`uint8_t` علامات متنوعة مرتبطة بالجلسة.
`MaxRcvdMsgId`	`uint32_t` الحد الأقصى لمعرِّف الرسالة الذي تم استلامه ضمن مفتاح الجلسة.
`MsgEncKey`	`WeaveMsgEncryptionKey` مفتاح تشفير رسالة Weave.
`NextMsgId`	`MonotonicallyIncreasingCounter` معرِّف الرسالة التالية المطلوب استخدامه ضمن مفتاح الجلسة.
`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()

Init

void Init(
  void
)

إعداد كائن WeaveSessionKey.

IsAllocated

bool IsAllocated() const

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

IsKeySet

bool IsKeySet() const

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

IsLocallyInitiated

bool IsLocallyInitiated() const

التفاصيل
المرتجعات	صحيح إذا بدأت الجلسة المحلية

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 عليها.