nl::Weave::WeaveServerBase

#include <src/lib/core/WeaveServerBase.h>

ออบเจ็กต์ฐานทั่วไปสำหรับการใช้โปรแกรมตอบกลับ (เซิร์ฟเวอร์) ที่ไม่ได้รับอนุญาตของโปรไฟล์ Weave ซึ่งรวมการตรวจสอบคำขอที่ตรวจสอบสิทธิ์แล้วและการส่งรายงานสถานะ รวมถึงจัดเก็บข้อมูลสมาชิกทั่วไปสำหรับสถานะ Fabric และตัวจัดการการแลกเปลี่ยน

สรุป

การสืบทอด

คลาสย่อยที่รู้จักโดยตรง:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer
  nl::Weave::Profiles::Echo_Next::WeaveEchoServer
  nl::Weave::Profiles::FabricProvisioning::FabricProvisioningServer
  nl::Weave::Profiles::Heartbeat::WeaveHeartbeatReceiver
  nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer
  nl::Weave::Profiles::ServiceProvisioning::ServiceProvisioningServer
  nl::Weave::Profiles::TokenPairing::TokenPairingServer
  nl::Weave::Profiles::Vendor::Nestlabs::DropcamLegacyPairing::DropcamLegacyPairingServer
  nl::Weave::Profiles::WeaveEchoServer

แอตทริบิวต์สาธารณะ
ExchangeMgr
[อ่านอย่างเดียว] ออบเจ็กต์ Exchange Manager
FabricState
[อ่านอย่างเดียว] ออบเจ็กต์สถานะ Fabric

ฟังก์ชันคงที่แบบสาธารณะ
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
ส่งรายงานสถานะ Weave พร้อมการแจ้งว่าข้อความเป็นค่าเริ่มต้นไปยังผู้เริ่มใน Exchange ที่ระบุซึ่งมีรหัสสถานะในโปรไฟล์ที่ระบุและข้อผิดพลาดของระบบ
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError, uint16_t sendFlags)
ส่งรายงานสถานะ Weave พร้อม Flag ข้อความที่ระบุไปยังผู้เริ่มใน Exchange ที่ระบุซึ่งมีรหัสสถานะในโปรไฟล์ที่ระบุและข้อผิดพลาดของระบบ

ฟังก์ชันที่มีการป้องกัน
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, WeaveServerDelegateBase *delegate)
bool
พิจารณาว่าควรยอมรับหรือทิ้งข้อความคำขอขาเข้าไปยังเซิร์ฟเวอร์ Weave
WeaveServerBase(void)

แอตทริบิวต์สาธารณะ

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[อ่านอย่างเดียว] ออบเจ็กต์ Exchange Manager

FabricState

WeaveFabricState * FabricState

[อ่านอย่างเดียว] ออบเจ็กต์สถานะ Fabric

ฟังก์ชันคงที่แบบสาธารณะ

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *ec,
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

ส่งรายงานสถานะ Weave พร้อมการแจ้งว่าข้อความเป็นค่าเริ่มต้นไปยังผู้เริ่มใน Exchange ที่ระบุซึ่งมีรหัสสถานะในโปรไฟล์ที่ระบุและข้อผิดพลาดของระบบ

รายละเอียด
พารามิเตอร์
[in] ec
ตัวชี้ไปยังบริบทการแลกเปลี่ยนเพื่อส่งรายงานสถานะ
[in] statusProfileId
โปรไฟล์สำหรับรหัสสถานะที่ระบุ
[in] statusCode
รหัสสถานะที่จะส่ง
[in] sysError
ข้อผิดพลาดของระบบเกี่ยวข้องหรือสัมพันธ์กับรหัสสถานะ

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *ec,
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError,
  uint16_t sendFlags
)

ส่งรายงานสถานะ Weave พร้อม Flag ข้อความที่ระบุไปยังผู้เริ่มใน Exchange ที่ระบุซึ่งมีรหัสสถานะในโปรไฟล์ที่ระบุและข้อผิดพลาดของระบบ

รายละเอียด
พารามิเตอร์
[in] ec
ตัวชี้ไปยังบริบทการแลกเปลี่ยนเพื่อส่งรายงานสถานะ
[in] statusProfileId
โปรไฟล์สำหรับรหัสสถานะที่ระบุ
[in] statusCode
รหัสสถานะที่จะส่ง
[in] sysError
ข้อผิดพลาดของระบบเกี่ยวข้องหรือสัมพันธ์กับรหัสสถานะ
[in] sendFlags
การตั้งค่า Flag โดยแอปพลิเคชันสำหรับการส่งรายงานสถานะของ Weave

ฟังก์ชันที่มีการป้องกัน

EnforceAccessControl

bool EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  WeaveServerDelegateBase *delegate
)

กำหนดว่าควรยอมรับหรือยกเลิกข้อความคำขอที่เข้ามาไปยังเซิร์ฟเวอร์ Weave

วิธีการนี้มีไว้สำหรับการใช้งานเซิร์ฟเวอร์ Weave เพื่อใช้นโยบายการควบคุมการเข้าถึงแบบขยายได้กับข้อความคำขอขาเข้า การติดตั้งใช้งานเซิร์ฟเวอร์ที่อาศัยออบเจ็กต์ผู้รับมอบสิทธิ์ควรเรียกใช้เมธอดนี้ตั้งแต่เนิ่นๆ ในการประมวลผลข้อความเพื่อพิจารณาว่าควรประมวลผลข้อความต่อหรือไม่

เมธอดนี้จะเรียกเมธอด WeaveServerDelegateBase::EnforceAccessControl() เสมือนในดีเลเกตที่ระบุเพื่อประเมินนโยบายการควบคุมการเข้าถึงสำหรับข้อความ คลาสตัวแทนของเซิร์ฟเวอร์ Weave และตัวแทนเฉพาะแอปพลิเคชันที่มาจากคลาสเซิร์ฟเวอร์มาตรฐานควรลบล้างเมธอดเสมือนจริงเพื่อบังคับใช้นโยบายการควบคุมการเข้าถึงที่เฉพาะเจาะจง

รายละเอียด
พารามิเตอร์
[in] ec
ExchangeContext ที่ได้รับข้อความ
[in] msgProfileId
รหัสโปรไฟล์ของข้อความที่ได้รับ
[in] msgType
ประเภทข้อความของข้อความที่ได้รับ
[in] msgInfo
โครงสร้าง WeaveMessageInfo ที่มีข้อมูลเกี่ยวกับข้อความที่ได้รับ
[in] delegate
ออบเจ็กต์การมอบสิทธิ์ที่แอปพลิเคชันใช้ซึ่งสามารถใช้ลบล้างนโยบายการควบคุมการเข้าถึงข้อความเริ่มต้นได้
ค่าที่แสดงผล
true
ระบุว่าควรยอมรับและประมวลผลข้อความตามปกติ
false
หากควรหยุดการประมวลผลข้อความและควรทิ้งข้อความ

WeaveServerBase

 WeaveServerBase(
  void
)