nl::Weave::WeaveServerBase

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

用于实现 Weave 未经请求响应者(服务器)的通用基础对象,可封装经过身份验证的请求并发送状态报告,并为结构状态和交换管理器提供通用的数据成员存储空间。

摘要

继承

图片说明:

公共属性

ExchangeMgr
[只读] Exchange 管理器对象
FabricState
[只读] Fabric 状态对象

公共静态函数

SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
向指定广告交易平台上的发起者发送包含默认消息标记的 Weave 状态报告,其中包含指定的配置文件和系统错误中的状态代码。
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError, uint16_t sendFlags)
向指定广告交易平台上的发起者发送包含所提供消息标记的 Weave 状态报告,其中包含指定的配置文件和系统错误中的状态代码。

受保护的函数

EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, WeaveServerDelegateBase *delegate)
bool
确定是接受还是舍弃发送到 Weave 服务器的传入消息。
WeaveServerBase(void)

公共属性

广告交易平台

WeaveExchangeManager * ExchangeMgr

[只读] Exchange 管理器对象

FabricState

WeaveFabricState * FabricState

[只读] Fabric 状态对象

公共静态函数

发送状态报告

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

向指定广告交易平台上的发起者发送包含默认消息标记的 Weave 状态报告,其中包含指定的配置文件和系统错误中的状态代码。

详细信息
参数
[in] ec
指向要向其发送状态报告的广告交易平台上下文的指针。
[in] statusProfileId
指定状态代码的配置文件。
[in] statusCode
要发送的状态代码。
[in] sysError
与状态代码关联的系统错误。

发送状态报告

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

向指定广告交易平台上的发起者发送包含所提供消息标记的 Weave 状态报告,其中包含指定的配置文件和系统错误中的状态代码。

详细信息
参数
[in] ec
指向要向其发送状态报告的广告交易平台上下文的指针。
[in] statusProfileId
指定状态代码的配置文件。
[in] statusCode
要发送的状态代码。
[in] sysError
与状态代码关联的系统错误。
[in] sendFlags
应用为要发送的 Weave 状态报告设置的标记。

受保护的函数

强制执行访问权限控制

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
收到的消息的个人资料 ID。
[in] msgType
收到的消息的消息类型。
[in] msgInfo
WeaveMessageInfo 结构,包含收到的消息的相关信息。
[in] delegate
应用提供的代理对象,可用于替换默认消息访问控制政策。
返回值
true
邮件是否应该被接受并照常处理。
false
如果消息处理应停止,且消息应被舍弃。

WeaveServerBase

 WeaveServerBase(
  void
)