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

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

用于实现设备控制配置文件的服务器类。

摘要

继承

沿用自： nl::Weave::WeaveServerBase
直接已知的子类： nl::Weave::DeviceLayer::Internal::DeviceControlServer

构造函数和析构函数
DeviceControlServer(void)

受保护的属性
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

公共函数
Init(WeaveExchangeManager *exchangeMgr)
初始化设备控制服务器状态并注册以接收设备控制消息。
IsRemotePassiveRendezvousInProgress(void) const
bool
返回远程被动 Rendezvous 状态。
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
向请求发送状态报告响应。
SendSuccessResponse(void)
virtual WEAVE_ERROR
向设备控制请求发送成功响应。
SetDelegate(DeviceControlDelegate *delegate)
void
设置用于处理设备控制服务器事件的委托。
Shutdown(void)
关闭设备控制服务器。
SystemTestTimeout(void)
void

受保护的属性

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

公共函数

DeviceControlServer

 DeviceControlServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

初始化设备控制服务器状态并注册以接收设备控制消息。

详细信息
参数
[in] exchangeMgr
指向 Weave Exchange Manager 的指针。
返回值
WEAVE_ERROR_INCORRECT_STATE
已注册远程被动集合服务器。
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
注册过多未经请求的消息处理程序时。
WEAVE_NO_ERROR
成功时。

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const

返回远程被动 Rendezvous 状态。

详细信息
返回值
TRUE
如果正在进行远程被动 Rendezvous。
FALSE
如果远程被动 Rendezvous 未在进行中。

SendStatusReport

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

向请求发送状态报告响应。

详细信息
参数
[in] statusProfileId
此状态报告所属的 Weave 配置文件 ID。
[in] statusCode
要包含在此响应中的状态代码。
[in] sysError
要包含在此响应中的系统错误代码。
返回值
WEAVE_ERROR_INCORRECT_STATE
如果没有正在处理的请求。
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定的错误代码，表示发生了错误，导致状态报告无法发送。

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

向设备控制请求发送成功响应。

详细信息
返回值
WEAVE_ERROR_INCORRECT_STATE
如果没有正在处理的请求。
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定的错误代码，表示发生了错误，导致成功响应无法发送。

SetDelegate

void SetDelegate(
  DeviceControlDelegate *delegate
)

设置用于处理设备控制服务器事件的委托。

详细信息
参数
[in] delegate
指向设备控制委托的指针。

关停

WEAVE_ERROR Shutdown(
  void
)

关闭设备控制服务器。

详细信息
返回值
WEAVE_NO_ERROR
。

SystemTestTimeout

void SystemTestTimeout(
  void
)