nl::Weave::Warm::Platform

摘要

函数
AddRemoveHostAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, uint8_t inPrefixLength, bool inAdd)
Warm 将调用的平台 API，以便为主机 TCP / IP 堆栈上的指定接口添加/移除主机 IP 地址。
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Warm 将调用的平台 API，以便为主机 TCP / IP 堆栈上的指定接口添加/移除 IP 路由。
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
Warm 将调用的平台 API，以便为 Thread TCP / IP 堆栈上的指定接口添加/移除 IP 地址。
AddRemoveThreadRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Warm 将调用的平台 API，以便为 Thread TCP / IP 堆栈上的指定接口添加/移除 IP 路由。
CriticalSectionEnter(void)
void
Warm 将调用的平台 API 来保护对内部状态的访问。
CriticalSectionExit(void)
void
Warm 将调用的平台 API，以释放对内部状态的受保护访问权限。
Init(WarmFabricStateDelegate *inFabricStateDelegate)
Warm 将在 nl::Warm::Init 执行期间调用的平台 API。
RequestInvokeActions(void)
void
Warm 将调用的平台 API，用于宣布平台应调用 InvokeActions。
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
Warm 将调用的平台 API，用于更改 Thread TCP/IP 堆栈上指定接口的现有 IP 路由的优先级。
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
Warm 将调用的平台 API，以在 Thread 接口上开始 / 停止 IP 前缀的通告。

函数

AddRemoveHostAddress

PlatformResult AddRemoveHostAddress(
  InterfaceType inInterfaceType,
  const Inet::IPAddress & inAddress,
  uint8_t inPrefixLength,
  bool inAdd
)

Warm 将调用的平台 API，以便为主机 TCP / IP 堆栈上的指定接口添加/移除主机 IP 地址。

完成后，平台必须通过最终结果调用 ReportActionComplete。

具体说明
参数
[in] inInterfaceType
要修改的接口。
[in] inAddress
要添加/移除的 IP 地址。
[in] inPrefixLength
inAddress 的前缀长度。
[in] inAdd
true 表示添加地址，false 表示移除地址。
返回值
kPlatformResultSuccess
此操作已成功完成。
kPlatformResultFailure
操作失败。
kPlatformResultInProgress
该操作将异步完成。

AddRemoveHostRoute

PlatformResult AddRemoveHostRoute(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority,
  bool inAdd
)

Warm 将调用的平台 API，以便为主机 TCP / IP 堆栈上的指定接口添加/移除 IP 路由。

完成后，平台必须通过最终结果调用 ReportActionComplete。

具体说明
参数
[in] inInterfaceType
要修改的接口。
[in] inPrefix
要添加 / 移除的 IP 前缀。
[in] inPriority
分配路由时要使用的优先级。
[in] inAdd
true 表示将前缀添加为路由，false 表示移除作为路由的前缀。
返回值
kPlatformResultSuccess
此操作已成功完成。
kPlatformResultFailure
操作失败。
kPlatformResultInProgress
该操作将异步完成。

AddRemoveThreadAddress

PlatformResult AddRemoveThreadAddress(
  InterfaceType inInterfaceType,
  const Inet::IPAddress & inAddress,
  bool inAdd
)

Warm 将调用的平台 API，以便为 Thread TCP / IP 堆栈上的指定接口添加/移除 IP 地址。

完成后，平台必须通过最终结果调用 ReportActionComplete。

具体说明
参数
[in] inInterfaceType
要修改的接口。
[in] inAddress
要添加/移除的 IP 地址。
[in] inAdd
true 表示添加地址，false 表示移除地址。
返回值
kPlatformResultSuccess
此操作已成功完成。
kPlatformResultFailure
操作失败。
kPlatformResultInProgress
该操作将异步完成。

AddRemoveThreadRoute

PlatformResult AddRemoveThreadRoute(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority,
  bool inAdd
)

Warm 将调用的平台 API，以便为 Thread TCP / IP 堆栈上的指定接口添加/移除 IP 路由。

完成后，平台必须通过最终结果调用 ReportActionComplete。

具体说明
参数
[in] inInterfaceType
要修改的接口。
[in] inPrefix
要分配 / 移除的 IP 前缀。
[in] inPriority
分配路由时要使用的优先级。
[in] inAdd
true 表示将前缀添加为路由，false 表示移除作为路由的前缀。
返回值
kPlatformResultSuccess
此操作已成功完成。
kPlatformResultFailure
操作失败。
kPlatformResultInProgress
该操作将异步完成。

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

Warm 将调用的平台 API 来保护对内部状态的访问。

CriticalSectionExit

void CriticalSectionExit(
  void
)

Warm 将调用的平台 API，以释放对内部状态的受保护访问权限。

Init

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

Warm 将在 nl::Warm::Init 执行期间调用的平台 API。

具体说明
参数
[in] inFabricStateDelegate
指向 fabricStateDelegate 对象的指针，Warm 用于接收结构体状态的更新。
返回值
如果成功，则为 WEAVE_NO_ERROR；否则为错误代码。

RequestInvokeActions

void RequestInvokeActions(
  void
)

Warm 将调用的平台 API，用于宣布平台应调用 InvokeActions。

SetThreadRoutePriority

PlatformResult SetThreadRoutePriority(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority
)

Warm 将调用的平台 API，用于更改 Thread TCP/IP 堆栈上指定接口的现有 IP 路由的优先级。

完成后，平台必须通过最终结果调用 ReportActionComplete。

具体说明
参数
[in] inInterfaceType
要修改的接口。
[in] inPrefix
要修改的 IP 前缀。
[in] inPriority
要应用于路由的新优先级。
返回值
kPlatformResultSuccess
此操作已成功完成。
kPlatformResultFailure
操作失败。
kPlatformResultInProgress
该操作将异步完成。

StartStopThreadAdvertisement

PlatformResult StartStopThreadAdvertisement(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  bool inStart
)

Warm 将调用的平台 API，以在 Thread 接口上开始 / 停止 IP 前缀的通告。

完成后，平台必须通过最终结果调用 ReportActionComplete。

具体说明
参数
[in] inInterfaceType
要修改的接口。
[in] inPrefix
应启动 / 停止通告的 IP 前缀。
[in] inStart
值为 true 表示开始投放广告，值为 false 表示停止广告。
返回值
kPlatformResultSuccess
此操作已成功完成。
kPlatformResultFailure
操作失败。
kPlatformResultInProgress
该操作将异步完成。