דף זה תורגם על ידי 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 }`	טיפוסים בני מנייה (enum)

מאפיינים ציבוריים
`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

פרטים
החזרות	הערך הוא True אם הוקצה האובייקט WeaveSessionKey.

IsKeySet

bool IsKeySet() const

פרטים
החזרות	הערך הוא True אם הערך של מפתח ההצפנה הוגדר באובייקט WeaveSessionKey.

IsLocallyInitiated

bool IsLocallyInitiated() const

פרטים
החזרות	הערך הוא True אם הסשן הופעל על ידי הצומת המקומי.

IsRecentlyActive

bool IsRecentlyActive() const

פרטים
החזרות	הערך הוא True אם הסשן היה פעיל בעבר.

IsRemoveOnIdle

bool IsRemoveOnIdle() const

פרטים
החזרות	הערך הוא True אם הסשן מסומן להסרה אוטומטית כשהוא לא פעיל במשך פרק זמן מסוים.

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.