nl::Weave::WeaveServerBase

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

Đối tượng cơ bản phổ biến để triển khai người trả lời (máy chủ) không mong muốn của hồ sơ Weave đóng gói xác thực các yêu cầu đã xác thực và gửi báo cáo trạng thái, đồng thời cung cấp bộ nhớ thành viên dữ liệu chung cho trạng thái kết nối và trình quản lý trao đổi.

Tóm tắt

Tính kế thừa

Nonanla:









nl::Weave::Profiles::DeviceControl::DeviceControlServernl::Weave::Profiles::DeviceDescription::DeviceDescriptionServernl::Weave::Profiles::Echo_Next::WeaveEchoServernl::Weave::Profiles::FabricProvisioning::FabricProvisioningServernl::Weave::Profiles::Heartbeat::WeaveHeartbeatReceivernl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServernl::Weave::Profiles::ServiceProvisioning::ServiceProvisioningServernl::Weave::Profiles::TokenPairing::TokenPairingServernl::Weave::Profiles::Vendor::Nestlabs::DropcamLegacyPairing::DropcamLegacyPairingServernl::Weave::Profiles::WeaveEchoServer

Thuộc tính công khai
ExchangeMgr
[READ ONLY] Đối tượng người quản lý Exchange
FabricState
[READ ONLY] Đối tượng trạng thái Fabric

Hàm tĩnh công khai
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
Gửi báo cáo trạng thái Weave kèm theo cờ thông báo mặc định tới trình tạo thực thể trên giao dịch được chỉ định, chứa mã trạng thái trong cấu hình được chỉ định và lỗi hệ thống.
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError, uint16_t sendFlags)
Gửi báo cáo trạng thái Weave cùng với các cờ thông báo được cung cấp tới trình khởi tạo trong giao dịch được chỉ định, chứa mã trạng thái trong cấu hình được chỉ định và lỗi hệ thống.

Hàm được bảo vệ
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, WeaveServerDelegateBase *delegate)
bool
Xác định xem nên chấp nhận hay huỷ thông báo yêu cầu gửi đến máy chủ Weave.
WeaveServerBase(void)

Thuộc tính công khai

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[READ ONLY] Đối tượng người quản lý Exchange

FabricState

WeaveFabricState * FabricState

[READ ONLY] Đối tượng trạng thái Fabric

Hàm tĩnh công khai

SendStatusReport

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

Gửi báo cáo trạng thái Weave kèm theo cờ thông báo mặc định tới trình tạo thực thể trên giao dịch được chỉ định, chứa mã trạng thái trong cấu hình được chỉ định và lỗi hệ thống.

Thông tin chi tiết
Các tham số
[in] ec
Con trỏ tới ngữ cảnh trao đổi để gửi báo cáo trạng thái.
[in] statusProfileId
Hồ sơ cho mã trạng thái được chỉ định.
[in] statusCode
Mã trạng thái để gửi.
[in] sysError
Lỗi hệ thống có liên quan hoặc có tương quan với mã trạng thái.

SendStatusReport

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

Gửi báo cáo trạng thái Weave cùng với các cờ thông báo được cung cấp tới trình khởi tạo trong giao dịch được chỉ định, chứa mã trạng thái trong cấu hình được chỉ định và lỗi hệ thống.

Thông tin chi tiết
Các tham số
[in] ec
Con trỏ tới ngữ cảnh trao đổi để gửi báo cáo trạng thái.
[in] statusProfileId
Hồ sơ cho mã trạng thái được chỉ định.
[in] statusCode
Mã trạng thái để gửi.
[in] sysError
Lỗi hệ thống có liên quan hoặc có tương quan với mã trạng thái.
[in] sendFlags
Cờ do ứng dụng đặt cho báo cáo trạng thái Weave đang được gửi.

Hàm được bảo vệ

EnforceAccessControl

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

Xác định xem nên chấp nhận hay huỷ thông báo yêu cầu gửi đến máy chủ Weave.

Phương thức này nhằm mục đích triển khai máy chủ Weave sử dụng để triển khai chính sách kiểm soát truy cập mở rộng cho các thông báo yêu cầu gửi đến. Quá trình triển khai máy chủ dựa trên đối tượng uỷ quyền nên gọi phương thức này sớm trong quá trình xử lý thông báo để xác định xem có nên tiếp tục xử lý thông báo hay không.

Phương thức này gọi phương thức WeaveServerdelegateBase::EnforceAccessControl() ảo trên đối tượng uỷ quyền được cung cấp để đánh giá chính sách kiểm soát quyền truy cập cho thông báo. Các lớp uỷ quyền máy chủ Weave và các đại diện dành riêng cho ứng dụng bắt nguồn từ các lớp máy chủ tiêu chuẩn sẽ ghi đè phương thức ảo để thực thi các chính sách kiểm soát quyền truy cập cụ thể.

Thông tin chi tiết
Các tham số
[in] ec
ExchangeContext thông báo nhận được.
[in] msgProfileId
Mã hồ sơ của thư đã nhận.
[in] msgType
Loại thông báo của thông báo đã nhận.
[in] msgInfo
Cấu trúc WeaveMessageInfo chứa thông tin về tin nhắn đã nhận.
[in] delegate
Đối tượng uỷ quyền do ứng dụng cung cấp có thể dùng để ghi đè chính sách kiểm soát quyền truy cập vào tin nhắn mặc định.
Giá trị trả về
true
Nếu thư được chấp nhận và xử lý như bình thường.
false
Nếu quá trình xử lý thông báo bị dừng và thông báo sẽ bị loại bỏ.

WeaveServerBase

 WeaveServerBase(
  void
)