nl::Weave::Warm::Platform

Сводка

Функции
AddRemoveHostAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, uint8_t inPrefixLength, bool inAdd)
API платформы, который Warm будет вызывать для добавления или удаления IP-адреса хоста в указанном интерфейсе в стеке TCP/IP хоста.
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
API платформы, который Warm будет вызывать для добавления или удаления IP-маршрута для указанного интерфейса в стеке TCP/IP хоста.
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
API платформы, который Warm будет вызывать для добавления или удаления IP-адреса в указанном интерфейсе в стеке TCP/IP Thread.
AddRemoveThreadRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
API платформы, который Warm будет вызывать для добавления или удаления IP-маршрута для указанного интерфейса в стеке TCP/IP Thread.
CriticalSectionEnter(void)
void
API платформы, который будет вызывать Warm для защиты доступа к внутреннему состоянию.
CriticalSectionExit(void)
void
API платформы, который будет вызывать Warm, чтобы снять защиту с доступа к внутреннему состоянию.
Init(WarmFabricStateDelegate *inFabricStateDelegate)
API платформы, который Warm будет вызывать в рамках выполнения nl::Warm::Init.
RequestInvokeActions(void)
void
API платформы, который будет вызывать Warm, чтобы сообщить, что платформа должна вызвать InvokeActions.
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
API платформы, который Warm будет вызывать для изменения приоритета существующего IP-маршрута для указанного интерфейса в стеке TCP/IP Thread.
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
API платформы, который Warm будет вызывать для запуска / остановки рекламы префикса IP в интерфейсе Thread.

Функции

AddRemoveHostAddress

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

API платформы, который Warm будет вызывать для добавления или удаления IP-адреса хоста в указанном интерфейсе в стеке TCP/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
)

API платформы, который Warm будет вызывать, чтобы добавить или удалить IP-маршрут для указанного интерфейса в стеке TCP/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
)

API платформы, который Warm будет вызывать для добавления или удаления IP-адреса в указанном интерфейсе в стеке TCP/IP Thread.

После завершения платформа должна вызвать 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
)

API платформы, который Warm будет вызывать для добавления или удаления IP-маршрута для указанного интерфейса в стеке TCP/IP Thread.

После завершения платформа должна вызвать ReportActionComplete с окончательным результатом.

Сведения
Параметры
[in] inInterfaceType
Интерфейс, который нужно изменить.
[in] inPrefix
Префикс IP-адреса, который нужно назначить или удалить.
[in] inPriority
Приоритет, который будет использоваться при назначении маршрута.
[in] inAdd
true, чтобы добавить префикс в качестве маршрута, или false, чтобы удалить префикс в качестве маршрута.
Возвращаемые значения
kPlatformResultSuccess
Операция выполнена успешно.
kPlatformResultFailure
Не удалось выполнить операцию.
kPlatformResultInProgress
Операция будет завершена асинхронно.

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

API платформы, который будет вызывать Warm для защиты доступа к внутреннему состоянию.

CriticalSectionExit

void CriticalSectionExit(
  void
)

API платформы, который будет вызывать Warm, чтобы снять защиту с доступа к внутреннему состоянию.

Init

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

API платформы, который Warm будет вызывать в рамках выполнения nl::Warm::Init.

Сведения
Параметры
[in] inFabricStateDelegate
Указатель на объект fabricStateDelegate, используемый Warm для получения обновлений состояния фабрики.
Возвраты
WEAVE_NO_ERROR в случае успеха, в противном случае – код ошибки.

RequestInvokeActions

void RequestInvokeActions(
  void
)

API платформы, который будет вызывать Warm, чтобы сообщить, что платформа должна вызвать InvokeActions.

SetThreadRoutePriority

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

API платформы, который Warm будет вызывать для изменения приоритета существующего IP-маршрута для указанного интерфейса в стеке TCP/IP Thread.

После завершения платформа должна вызвать ReportActionComplete с окончательным результатом.

Сведения
Параметры
[in] inInterfaceType
Интерфейс, который нужно изменить.
[in] inPrefix
Префикс IP, который нужно изменить.
[in] inPriority
Новый приоритет, который нужно применить к маршруту.
Возвращаемые значения
kPlatformResultSuccess
Операция выполнена успешно.
kPlatformResultFailure
Не удалось выполнить операцию.
kPlatformResultInProgress
Операция будет завершена асинхронно.

StartStopThreadAdvertisement

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

API платформы, который Warm будет вызывать для запуска / остановки рекламы префикса IP в интерфейсе Thread.

После завершения платформа должна вызвать ReportActionComplete с окончательным результатом.

Сведения
Параметры
[in] inInterfaceType
Интерфейс, который нужно изменить.
[in] inPrefix
Префикс IP-адреса, для которого нужно начать или остановить объявление.
[in] inStart
true, чтобы начать объявление, false, чтобы остановить объявление.
Возвращаемые значения
kPlatformResultSuccess
Операция выполнена успешно.
kPlatformResultFailure
Не удалось выполнить операцию.
kPlatformResultInProgress
Операция будет завершена асинхронно.