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

เริ่มต้น

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