nl::Weave::Warm::Platform

Podsumowanie

Funkcje

AddRemoveHostAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, uint8_t inPrefixLength, bool inAdd)
Interfejs API platformy, który wywoła Warm, aby dodać adres IP hosta do określonego interfejsu w stosie TCP/IP hosta lub go usunąć.
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Interfejs API platformy, który wywoła Warm, aby dodać lub usunąć trasę IP dla określonego interfejsu na hoście stosu TCP/IP.
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
Interfejs API platformy, który wywoła Warm, aby dodać lub usunąć adres IP do określonego interfejsu w stosie TCP/IP Thread.
AddRemoveThreadRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Interfejs API platformy, który wywoła Warm, aby dodać lub usunąć trasę IP dla określonego interfejsu w stosie TCP/IP Thread.
CriticalSectionEnter(void)
void
Interfejs API platformy, który Warm wywoła, aby chronić dostęp do stanu wewnętrznego.
CriticalSectionExit(void)
void
Interfejs API platformy, który Warm wywoła, aby zwolnić chroniony dostęp do stanu wewnętrznego.
Init(WarmFabricStateDelegate *inFabricStateDelegate)
Interfejs API platformy, który Warm wywoła w ramach wykonania polecenia nl::Warm::Init.
RequestInvokeActions(void)
void
Interfejs API platformy, który będzie wywoływany przez Warm, aby poinformować, że platforma powinna wywoływać InvokeActions.
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
Interfejs API platformy, który wywoła Warm, aby zmienić priorytet istniejącej trasy IP dla określonego interfejsu w stosie Thread TCP/IP.
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
Interfejs API platformy, który Warm wywoła, aby uruchomić lub zatrzymać reklamowanie prefiksu IP w interfejsie Thread.

Funkcje

AddRemoveHostAddress

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

Interfejs API platformy, który wywoła Warm, aby dodać adres IP hosta do określonego interfejsu w stosie TCP/IP hosta lub go usunąć.

Po zakończeniu platforma musi wywołać funkcję ReportActionComplete z wynikiem końcowym.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do modyfikacji.
[in] inAddress
Adres IP, który ma zostać dodany lub usunięty.
[in] inPrefixLength
Długość prefiksu elementu inAddress.
[in] inAdd
„true”, aby dodać adres, lub „false”, aby go usunąć.
Zwracane wartości
kPlatformResultSuccess
Operacja została zakończona.
kPlatformResultFailure
Operacja nie powiodła się.
kPlatformResultInProgress
Operacja zostanie dokończona asynchronicznie.

AddRemoveHostRoute

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

Interfejs API platformy, który wywoła Warm, aby dodać lub usunąć trasę IP dla określonego interfejsu na hoście stosu TCP/IP.

Po zakończeniu platforma musi wywołać funkcję ReportActionComplete z wynikiem końcowym.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do modyfikacji.
[in] inPrefix
Prefiks adresu IP do dodania / usunięcia.
[in] inPriority
Priorytet, który ma być używany po przypisaniu trasy.
[in] inAdd
true (prawda), aby dodać prefiks jako trasę, lub false, aby usunąć prefiks jako trasę.
Zwracane wartości
kPlatformResultSuccess
Operacja została zakończona.
kPlatformResultFailure
Operacja nie powiodła się.
kPlatformResultInProgress
Operacja zostanie dokończona asynchronicznie.

AddRemoveThreadAddress

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

Interfejs API platformy, który wywoła Warm, aby dodać lub usunąć adres IP do określonego interfejsu w stosie TCP/IP Thread.

Po zakończeniu platforma musi wywołać funkcję ReportActionComplete z wynikiem końcowym.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do modyfikacji.
[in] inAddress
Adres IP, który ma zostać dodany lub usunięty.
[in] inAdd
„true”, aby dodać adres, lub „false”, aby go usunąć.
Zwracane wartości
kPlatformResultSuccess
Operacja została zakończona.
kPlatformResultFailure
Operacja nie powiodła się.
kPlatformResultInProgress
Operacja zostanie dokończona asynchronicznie.

AddRemoveThreadRoute

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

Interfejs API platformy, który wywoła Warm, aby dodać lub usunąć trasę IP dla określonego interfejsu w stosie TCP/IP Thread.

Po zakończeniu platforma musi wywołać funkcję ReportActionComplete z wynikiem końcowym.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do modyfikacji.
[in] inPrefix
Prefiks IP do przypisania lub usunięcia.
[in] inPriority
Priorytet, który ma być używany po przypisaniu trasy.
[in] inAdd
true (prawda), aby dodać prefiks jako trasę, lub false, aby usunąć prefiks jako trasę.
Zwracane wartości
kPlatformResultSuccess
Operacja została zakończona.
kPlatformResultFailure
Operacja nie powiodła się.
kPlatformResultInProgress
Operacja zostanie dokończona asynchronicznie.

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

Interfejs API platformy, który Warm wywoła, aby chronić dostęp do stanu wewnętrznego.

CriticalSectionExit

void CriticalSectionExit(
  void
)

Interfejs API platformy, który Warm wywoła, aby zwolnić chroniony dostęp do stanu wewnętrznego.

Zainicjuj

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

Interfejs API platformy, który Warm wywoła w ramach wykonania polecenia nl::Warm::Init.

Szczegóły
Parametry
[in] inFabricStateDelegate
Wskaźnik do obiektu FabricStateDelegacji używany przez obiekt Warm do odbierania aktualizacji stanu tkaniny.
Zwroty
W przypadku powodzenia: WEAVE_NO_ERROR. W przeciwnym razie kod błędu.

RequestInvokeActions

void RequestInvokeActions(
  void
)

Interfejs API platformy, który będzie wywoływany przez Warm, aby poinformować, że platforma powinna wywoływać InvokeActions.

SetThreadRoutePriority

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

Interfejs API platformy, który wywoła Warm, aby zmienić priorytet istniejącej trasy IP dla określonego interfejsu w stosie Thread TCP/IP.

Po zakończeniu platforma musi wywołać funkcję ReportActionComplete z wynikiem końcowym.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do modyfikacji.
[in] inPrefix
Prefiks IP do zmiany.
[in] inPriority
Nowy priorytet, który ma zostać zastosowany do trasy.
Zwracane wartości
kPlatformResultSuccess
Operacja została zakończona.
kPlatformResultFailure
Operacja nie powiodła się.
kPlatformResultInProgress
Operacja zostanie dokończona asynchronicznie.

StartStopThreadAdvertisement

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

Interfejs API platformy, który Warm wywoła, aby uruchomić lub zatrzymać reklamowanie prefiksu IP w interfejsie Thread.

Po zakończeniu platforma musi wywołać funkcję ReportActionComplete z wynikiem końcowym.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do modyfikacji.
[in] inPrefix
Prefiks adresu IP, dla którego chcesz rozpocząć / zatrzymać wyświetlanie reklam.
[in] inStart
Prawda, aby rozpocząć wyświetlanie reklam, lub false, aby zatrzymać wyświetlanie reklam.
Zwracane wartości
kPlatformResultSuccess
Operacja została zakończona.
kPlatformResultFailure
Operacja nie powiodła się.
kPlatformResultInProgress
Operacja zostanie dokończona asynchronicznie.