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()

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_IsShared हवादार फ़्लैग को सेट किया जाना है.