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

इस सेशन को निलंबित कर दिया गया है.

सार्वजनिक विशेषताएं

पुष्टीकरण मोड

WeaveAuthMode AuthMode

वह तरीका जिससे पीयर नोड की पुष्टि सेशन के दौरान की गई थी.

बाउंडकॉन

WeaveConnection * BoundCon

वह कनेक्शन जिससे कुंजी जुड़ी है.

झंडे

uint8_t Flags

सत्र से जुड़े कई फ़्लैग.

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

सेशन कुंजी के तहत मिला ज़्यादा से ज़्यादा मैसेज आईडी.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

Weave मैसेज के लिए एन्क्रिप्ट (सुरक्षित) करने का बटन.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

सेशन कुंजी के तहत इस्तेमाल किया जाने वाला अगला मैसेज आईडी.

नोड आईडी

uint64_t NodeId

उस नोड का आईडी जिसके साथ सेशन कुंजी शेयर की गई है.

Rcvफ़्लैग

WeaveSessionState::ReceiveFlagsType RcvFlags

कुंजी के नीचे मिलने वाले फ़्लैग ट्रैकिंग मैसेज.

रिज़र्व काउंट

uint8_t ReserveCount

सेशन कुंजी रिज़र्व किए जाने की संख्या.

सार्वजनिक फ़ंक्शन

साफ़ मौसम

void Clear(
  void
)

WeaveSessionKey ऑब्जेक्ट को रीसेट करें.

हाल ही के सक्रिय

void ClearRecentlyActive()

सेशन को सिग्नल करता है, क्योंकि यह हाल ही में चालू नहीं था.

निलंबित किया गया खाता हटाएं

void ClearSuspended()

इनिट

void Init(
  void
)

WeaveSessionKey ऑब्जेक्ट को शुरू करें.

आवंटित किया गया

bool IsAllocated() const 

ब्यौरा
लौटाए गए सामान
अगर WeaveSessionKey ऑब्जेक्ट का बंटवारा किया गया, तो यह सही होगा.

IsKeySet

bool IsKeySet() const 

ब्यौरा
लौटाए गए सामान
सही है अगर एन्क्रिप्शन कुंजी का मान WeaveSessionKey ऑब्जेक्ट में सेट किया गया है.

स्थानीय स्तर पर शुरू किया गया

bool IsLocallyInitiated() const 

ब्यौरा
लौटाए गए सामान
अगर सेशन स्थानीय नोड से शुरू हुआ था, तो सही है.

हाल ही में इस्तेमाल किया गया

bool IsRecentlyActive() const 

ब्यौरा
लौटाए गए सामान
अगर सेशन हाल ही में चालू रहा है, तो सही है.

IsRemoveOnIdle

bool IsRemoveOnIdle() const 

ब्यौरा
लौटाए गए सामान
अगर सेशन कुछ समय तक डिवाइस का इस्तेमाल नहीं करता, तो अपने-आप हटाने के लिए फ़्लैग किया जाता है.

IsSharedSession

bool IsSharedSession() const 

निलंबित किया गया

bool IsSuspended() const 

Markहाल ही में चालू

void MarkRecentlyActive()

सेशन के हाल के चालू होने के बारे में सिग्नल.

निलंबित किया गया

void MarkSuspended()

सेट किया गया

void SetLocallyInitiated(
  bool val
)

setRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

यह तय करने वाला फ़्लैग सेट करता है कि कुछ समय तक डिवाइस को इस्तेमाल न किए जाने पर, सेशन को अपने-आप हटा दिया जाना चाहिए या नहीं.

ब्यौरा
पैरामीटर
[in] val
kFlag_IsRemoveOnIdle को सेट करने के लिए वैल्यू.

सेट शेयर किया गया सेशन

void SetSharedSession(
  bool val
)

यह बताने वाला फ़्लैग सेट करता है कि सेशन, शेयर किया गया सेशन है या नहीं.

ब्यौरा
पैरामीटर
[in] val
kFlag_IsSharedSession फ़्लैग को सेट करने के लिए वैल्यू.