nl::Weave::Profiles::DeviceControl::DeviceControlServer

#include <src/lib/profiles/device-control/DeviceControl.h>

Lớp máy chủ để triển khai hồ sơ Kiểm soát thiết bị.

Tóm tắt

Tính kế thừa

Kế thừa từ: nl::Weave::WeaveServerBase
Lớp học con đã biết trực tiếp: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Hàm khởi tạo và phá huỷ
DeviceControlServer(void)

Thuộc tính được bảo vệ
mCurClientOp
mDelegate
mFailSafeArmed
bool
mFailSafeToken
uint32_t
mRemotePassiveRendezvousClientCon
mRemotePassiveRendezvousEncryptionType
uint8_t
mRemotePassiveRendezvousJoinerAddr
mRemotePassiveRendezvousJoinerCon
mRemotePassiveRendezvousKeyId
uint16_t
mRemotePassiveRendezvousOp
mRemotePassiveRendezvousTimeout
uint16_t
mRemotePassiveRendezvousTunnel
mResetFlags
uint16_t
mTunnelInactivityTimeout
uint16_t

Hàm công khai
Init(WeaveExchangeManager *exchangeMgr)
Khởi động trạng thái Máy chủ kiểm soát thiết bị và đăng ký nhận thông báo Kiểm soát thiết bị.
IsRemotePassiveRendezvousInProgress(void) const
bool
Trả về trạng thái Điểm hẹn thụ động từ xa.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Gửi phản hồi báo cáo trạng thái cho một yêu cầu.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Gửi phản hồi thành công cho yêu cầu Kiểm soát thiết bị.
SetDelegate(DeviceControlDelegate *delegate)
void
Đặt phương thức uỷ quyền để xử lý sự kiện Máy chủ kiểm soát thiết bị.
Shutdown(void)
Tắt máy chủ điều khiển thiết bị.
SystemTestTimeout(void)
void

Thuộc tính được bảo vệ

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

DeviceControlDelegate * mDelegate

mFailSafeArmed

bool mFailSafeArmed

mFailSafeToken

uint32_t mFailSafeToken

mRemotePassiveRendezvousClientCon

WeaveConnection * mRemotePassiveRendezvousClientCon

mRemotePassiveRendezvousEncryptionType

uint8_t mRemotePassiveRendezvousEncryptionType

mRemotePassiveRendezvousJoinerAddr

IPAddress mRemotePassiveRendezvousJoinerAddr

mRemotePassiveRendezvousJoinerCon

WeaveConnection * mRemotePassiveRendezvousJoinerCon

mRemotePassiveRendezvousKeyId

uint16_t mRemotePassiveRendezvousKeyId

mRemotePassiveRendezvousOp

ExchangeContext * mRemotePassiveRendezvousOp

mRemotePassiveRendezvousTimeout

uint16_t mRemotePassiveRendezvousTimeout

mRemotePassiveRendezvousTunnel

WeaveConnectionTunnel * mRemotePassiveRendezvousTunnel

mResetFlags

uint16_t mResetFlags

mTunnelInactivityTimeout

uint16_t mTunnelInactivityTimeout

Hàm công khai

DeviceControlServer

 DeviceControlServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Khởi động trạng thái Máy chủ kiểm soát thiết bị và đăng ký nhận thông báo Kiểm soát thiết bị.

Thông tin chi tiết
Tham số
[in] exchangeMgr
Con trỏ trỏ đến Weave Exchange Manager.
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Khi một máy chủ điểm hẹn thụ động từ xa đã được đăng ký.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Khi có quá nhiều trình xử lý tin nhắn không mong muốn được đăng ký.
WEAVE_NO_ERROR
Khi thành công.

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const

Trả về trạng thái Điểm hẹn thụ động từ xa.

Thông tin chi tiết
Giá trị trả về
TRUE
nếu Cuộc hẹn bị động từ xa đang diễn ra.
FALSE
nếu Không thể tiến hành Cuộc hẹn bị động từ xa.

SendStatusReport

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

Gửi phản hồi báo cáo trạng thái cho một yêu cầu.

Thông tin chi tiết
Tham số
[in] statusProfileId
Mã hồ sơ Weave có liên quan đến báo cáo trạng thái này.
[in] statusCode
Mã trạng thái được đưa vào phản hồi này.
[in] sysError
Mã lỗi hệ thống được đưa vào phản hồi này.
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Nếu không có yêu cầu nào đang được xử lý.
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi khác của Weave hoặc dành riêng cho nền tảng cho biết đã xảy ra lỗi khiến báo cáo trạng thái không gửi được.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Gửi phản hồi thành công cho yêu cầu Kiểm soát thiết bị.

Thông tin chi tiết
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Nếu không có yêu cầu nào đang được xử lý.
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi riêng của Weave hoặc nền tảng cụ thể khác cho biết đã xảy ra lỗi khiến không thể gửi phản hồi thành công.

SetDelegate

void SetDelegate(
  DeviceControlDelegate *delegate
)

Đặt phương thức uỷ quyền để xử lý sự kiện Máy chủ kiểm soát thiết bị.

Thông tin chi tiết
Tham số
[in] delegate
Con trỏ trỏ đến Người được uỷ quyền điều khiển thiết bị.

Tắt

WEAVE_ERROR Shutdown(
  void
)

Tắt máy chủ điều khiển thiết bị.

Thông tin chi tiết
Giá trị trả về
WEAVE_NO_ERROR
một cách vô điều kiện.

SystemTestTimeout

void SystemTestTimeout(
  void
)