nl::
#include <src/lib/core/WeaveFabricState.h>
มีข้อมูลเกี่ยวกับคีย์เซสชัน Weave
สรุป
ประเภทสาธารณะ |
|
|---|---|
FlagsEnum{
|
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
ตั้งค่าสถานะเพื่อระบุว่าเซสชันนั้นเป็นเซสชันที่แชร์หรือไม่
|
ประเภทสาธารณะ
ธง Enum
FlagsEnum
| พร็อพเพอร์ตี้ | |
|---|---|
kFlag_IsLocallyInitiated
|
เซสชันเริ่มต้นโดยโหนดภายใน |
kFlag_IsRemoveOnIdle
|
ควรนําเซสชันออกเมื่อไม่มีการใช้งาน (มีผลเฉพาะกับเซสชันที่ไม่ได้เชื่อมโยงกับการเชื่อมต่อเท่านั้น) |
kFlag_IsSharedSession
|
เซสชันนี้คือเซสชันที่แชร์ร่วมกัน |
kFlag_RecentlyActive
|
เซสชันเพิ่งมีผลเมื่อเร็วๆ นี้ |
kFlag_Suspended
|
เซสชันถูกระงับแล้ว |
แอตทริบิวต์สาธารณะ
โหมดการตรวจสอบสิทธิ์
WeaveAuthMode AuthMode
วิธีการตรวจสอบสิทธิ์โหนดเพียร์ระหว่างการสร้างเซสชัน
ธง
uint8_t Flags
การติดธงหลายรายการที่เชื่อมโยงกับเซสชัน
MaxCcvdMsgId
uint32_t MaxRcvdMsgId
รหัสข้อความสูงสุดที่ได้รับภายใต้คีย์เซสชัน
รหัสโหนด
uint64_t NodeId
รหัสของโหนดที่มีการแชร์คีย์เซสชัน
รายงานว่าไม่เหมาะสม
WeaveSessionState::ReceiveFlagsType RcvFlags
แจ้งสถานะการติดตามข้อความที่ได้รับภายใต้คีย์
จํานวนจอง
uint8_t ReserveCount
จํานวนครั้งที่มีการจองคีย์เซสชัน
ฟังก์ชันสาธารณะ
ล้างที่ใช้งานเมื่อเร็วๆ นี้
void ClearRecentlyActive()
ส่งสัญญาณว่าเซสชันนี้ไม่ได้ใช้งานอยู่ในช่วงที่ผ่านมา
ล้างข้อมูลที่ถูกระงับ
void ClearSuspended()
จัดสรรแล้ว
bool IsAllocated() const
| รายละเอียด | |
|---|---|
| การคืนสินค้า |
เป็นจริงหากจัดสรรออบเจ็กต์ WeaveSessionKey
|
ชุดคีย์
bool IsKeySet() const
| รายละเอียด | |
|---|---|
| การคืนสินค้า |
เป็นจริงหากตั้งค่าคีย์การเข้ารหัสในออบเจ็กต์ WeaveSessionKey
|
เริ่มโดยท้องถิ่น
bool IsLocallyInitiated() const
| รายละเอียด | |
|---|---|
| การคืนสินค้า |
เป็นจริงหากเซสชันเริ่มต้นโดยโหนดภายใน
|
ใช้งานล่าสุด
bool IsRecentlyActive() const
| รายละเอียด | |
|---|---|
| การคืนสินค้า |
เป็นจริงหากเซสชันมีการใช้งานในอดีตที่ผ่านมา
|
IsRemoveOnIdle
bool IsRemoveOnIdle() const
| รายละเอียด | |
|---|---|
| การคืนสินค้า |
เป็นจริงหากระบบแจ้งว่าเซสชันถูกนําออกโดยอัตโนมัติเมื่อไม่มีการใช้งานเป็นระยะเวลาหนึ่ง
|
เซสชันที่ใช้ร่วมกัน
bool IsSharedSession() const
ถูกระงับ
bool IsSuspended() const
ทําเครื่องหมายว่ามีการใช้งานเมื่อเร็วๆ นี้
void MarkRecentlyActive()
ส่งสัญญาณให้เซสชันนี้มีการใช้งานอยู่ในอดีต
ทําเครื่องหมายว่าถูกระงับ
void MarkSuspended()
ตั้งค่าเริ่มต้นในท้องถิ่น
void SetLocallyInitiated( bool val )
ตั้งค่าการนําออก
void SetRemoveOnIdle( bool val )
ตั้งค่าการติดธงเพื่อระบุว่าควรนําเซสชันออกโดยอัตโนมัติหลังจากไม่มีการใช้งานหรือไม่
| รายละเอียด | |||
|---|---|---|---|
| พารามิเตอร์ |
|
||
ตั้งค่าเซสชันที่แชร์แล้ว
void SetSharedSession( bool val )
ตั้งค่าสถานะเพื่อระบุว่าเซสชันนั้นเป็นเซสชันที่แชร์หรือไม่
| รายละเอียด | |||
|---|---|---|---|
| พารามิเตอร์ |
|
||