nl::Weave::Warm::Platform

Resumen

Funciones
AddRemoveHostAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, uint8_t inPrefixLength, bool inAdd)
Una API de la plataforma que Warm llamará para agregar o quitar una dirección IP de host de la interfaz especificada en la pila de TCP/IP del host.
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Una API de la plataforma que Warm llamará a fin de agregar o quitar una ruta IP para la interfaz especificada en la pila de TCP/IP del host.
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
Una API de la plataforma que usará Warm para agregar o quitar una dirección IP de la interfaz especificada en la pila TCP/IP de Thread
AddRemoveThreadRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Una API de la plataforma que Warm llamará a fin de agregar o quitar una ruta IP para la interfaz especificada en la pila TCP/IP de Thread.
CriticalSectionEnter(void)
void
Una API de la plataforma que llamará Warm para proteger el acceso al estado interno.
CriticalSectionExit(void)
void
Una API de la plataforma que Warm llamará para liberar el acceso protegido al estado interno.
Init(WarmFabricStateDelegate *inFabricStateDelegate)
Una API de la plataforma a la que Warm llamará como parte de la ejecución de nl::Warm::Init
RequestInvokeActions(void)
void
Una API de plataforma que Warm llamará para anunciar que la plataforma debe llamar a InvokeActions.
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
Una API de la plataforma que usa Warm para cambiar la prioridad de una ruta IP existente para la interfaz especificada en la pila TCP/IP de Thread
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
Una API de la plataforma que Warm llamará para iniciar o detener el anuncio de un prefijo de IP en la interfaz de Thread.

Funciones

AddRemoveHostAddress

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

Una API de la plataforma que Warm llamará para agregar o quitar una dirección IP de host de la interfaz especificada en la pila de TCP/IP del host.

Una vez finalizada, la plataforma debe llamar a ReportActionComplete con el resultado final.

Detalles
Parámetros
[in] inInterfaceType
La interfaz que se modificará.
[in] inAddress
La dirección IP que se agregará o quitará.
[in] inPrefixLength
La longitud del prefijo de la inAddress.
[in] inAdd
true para agregar la dirección, false para eliminar la dirección.
Valores de retorno
kPlatformResultSuccess
La operación se completó correctamente.
kPlatformResultFailure
No se pudo realizar la operación.
kPlatformResultInProgress
La operación se completará de forma asíncrona.

AddRemoveHostRoute

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

Una API de la plataforma que Warm llamará a fin de agregar o quitar una ruta IP para la interfaz especificada en la pila de TCP/IP del host.

Una vez finalizada, la plataforma debe llamar a ReportActionComplete con el resultado final.

Detalles
Parámetros
[in] inInterfaceType
La interfaz que se modificará.
[in] inPrefix
El prefijo de IP para agregar o quitar.
[in] inPriority
La prioridad que se debe usar cuando se asigna la ruta.
[in] inAdd
true para agregar el prefijo como una ruta, false para quitar el prefijo como ruta.
Valores de retorno
kPlatformResultSuccess
La operación se completó correctamente.
kPlatformResultFailure
No se pudo realizar la operación.
kPlatformResultInProgress
La operación se completará de forma asíncrona.

AddRemoveThreadAddress

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

Una API de la plataforma que usará Warm para agregar o quitar una dirección IP de la interfaz especificada en la pila TCP/IP de Thread

Una vez finalizada, la plataforma debe llamar a ReportActionComplete con el resultado final.

Detalles
Parámetros
[in] inInterfaceType
La interfaz que se modificará.
[in] inAddress
La dirección IP que se agregará o quitará.
[in] inAdd
true para agregar la dirección, false para eliminar la dirección.
Valores de retorno
kPlatformResultSuccess
La operación se completó correctamente.
kPlatformResultFailure
No se pudo realizar la operación.
kPlatformResultInProgress
La operación se completará de forma asíncrona.

AddRemoveThreadRoute

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

Una API de la plataforma que Warm llamará a fin de agregar o quitar una ruta IP para la interfaz especificada en la pila TCP/IP de Thread.

Una vez finalizada, la plataforma debe llamar a ReportActionComplete con el resultado final.

Detalles
Parámetros
[in] inInterfaceType
La interfaz que se modificará.
[in] inPrefix
El prefijo de IP para asignar o quitar.
[in] inPriority
La prioridad que se debe usar cuando se asigna la ruta.
[in] inAdd
true para agregar el prefijo como una ruta, false para quitar el prefijo como ruta.
Valores de retorno
kPlatformResultSuccess
La operación se completó correctamente.
kPlatformResultFailure
No se pudo realizar la operación.
kPlatformResultInProgress
La operación se completará de forma asíncrona.

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

Una API de la plataforma que llamará Warm para proteger el acceso al estado interno.

CriticalSectionExit

void CriticalSectionExit(
  void
)

Una API de la plataforma que Warm llamará para liberar el acceso protegido al estado interno.

Init

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

Una API de la plataforma a la que Warm llamará como parte de la ejecución de nl::Warm::Init

Detalles
Parámetros
[in] inFabricStateDelegate
Un puntero al objeto fabricStateDelegate que usa Warm para recibir actualizaciones del estado de la estructura.
Resultado que se muestra
WEAVE_NO_ERROR si la operación se realiza correctamente; de lo contrario, se produce un error.

RequestInvokeActions

void RequestInvokeActions(
  void
)

Una API de plataforma que Warm llamará para anunciar que la plataforma debe llamar a InvokeActions.

SetThreadRoutePriority

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

Una API de la plataforma que usa Warm para cambiar la prioridad de una ruta IP existente para la interfaz especificada en la pila TCP/IP de Thread

Una vez finalizada, la plataforma debe llamar a ReportActionComplete con el resultado final.

Detalles
Parámetros
[in] inInterfaceType
La interfaz que se modificará.
[in] inPrefix
El prefijo de IP que se modificará.
[in] inPriority
La nueva prioridad que se aplicará a la ruta.
Valores de retorno
kPlatformResultSuccess
La operación se completó correctamente.
kPlatformResultFailure
No se pudo realizar la operación.
kPlatformResultInProgress
La operación se completará de forma asíncrona.

StartStopThreadAdvertisement

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

Una API de la plataforma que Warm llamará para iniciar o detener el anuncio de un prefijo de IP en la interfaz de Thread.

Una vez finalizada, la plataforma debe llamar a ReportActionComplete con el resultado final.

Detalles
Parámetros
[in] inInterfaceType
La interfaz que se modificará.
[in] inPrefix
Es el prefijo de IP para el cual la publicidad debe iniciarse o detenerse.
[in] inStart
true para comenzar a publicar anuncios, falso para dejar de publicar anuncios.
Valores de retorno
kPlatformResultSuccess
La operación se completó correctamente.
kPlatformResultFailure
No se pudo realizar la operación.
kPlatformResultInProgress
La operación se completará de forma asíncrona.