nl:: بافت:: WeaveSessionKey

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

حاوی اطلاعاتی درباره کلید جلسه Weave است.

خلاصه

انواع عمومی

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

صفات عمومی

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 را راه اندازی کنید.

اختصاص داده شده است

bool IsAllocated() const 

جزئیات
برمی گرداند
اگر شی WeaveSessionKey تخصیص داده شود درست است.

IsKeySet

bool IsKeySet() const 

جزئیات
برمی گرداند
اگر مقدار کلید رمزگذاری در یک شی WeaveSessionKey تنظیم شده باشد صحیح است.

IsLocallyInitiated

bool IsLocallyInitiated() const 

جزئیات
برمی گرداند
درست است اگر جلسه توسط گره محلی آغاز شده باشد.

IsRecently Active

bool IsRecentlyActive() const 

جزئیات
برمی گرداند
درست است اگر جلسه در گذشته اخیر فعال بوده باشد.

IsRemoveOnIdle

bool IsRemoveOnIdle() const 

جزئیات
برمی گرداند
درست است اگر جلسه برای یک دوره زمانی بی‌حرکت برای حذف خودکار پرچم‌گذاری شده باشد.

IsSharedSession

bool IsSharedSession() const 

تعلیق شده است

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 را روی آن تنظیم کنید.