หน้านี้ได้รับการแปลโดย 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

รายละเอียด
การคืนสินค้า	เป็นจริงหากมีการจัดสรรออบเจ็กต์ 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_IsSharedSession