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
החיבור שאליו קשור המפתח.
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 

פרטים
החזרות
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
הערך שאליו יש להגדיר את סימון kflags_IsRemoveOnIdle.

SetSharedSession

void SetSharedSession(
  bool val
)

מגדיר דגל שמציין אם הסשן הוא סשן משותף.

פרטים
פרמטרים
[in] val
הערך שאליו יש להגדיר את הסימון kFlag_IsSharedSession.