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 przez funkcję Warm w celu dodania lub usunięcia adresu IP hosta do określonego interfejsu w stosie TCP/IP hosta.
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Interfejs API platformy, który będzie wywoływany przez funkcję Warm w celu dodania lub usunięcia trasy IP dla określonego interfejsu w stosie TCP/IP hosta.
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
Interfejs API platformy, który będzie wywoływany przez funkcję Warm w celu dodania lub usunięcia adresu 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 będzie wywoływany przez funkcję Warm, aby dodać lub usunąć trasę IP dla określonego interfejsu w stosie TCP/IP Thread.
CriticalSectionEnter(void)
void
Interfejs API platformy, który będzie wywoływany przez funkcję Warm w celu ochrony dostępu do wewnętrznego stanu.
CriticalSectionExit(void)
void
Interfejs API platformy, który będzie wywoływany przez funkcję Warm w celu udostępnienia chronionego dostępu do stanu wewnętrznego.
Init(WarmFabricStateDelegate *inFabricStateDelegate)
Interfejs API platformy, który zostanie wywołany przez Warm w ramach wykonania kodu nl::Warm::Init.
RequestInvokeActions(void)
void
Interfejs API platformy, który będzie wywoływany przez funkcję Warm, aby poinformować, że platforma powinna wywołać InvokeActions.
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
Interfejs API platformy, który będzie wywoływany przez funkcję Warm, aby zmienić priorytet istniejącej trasy IP dla określonego interfejsu w stosie TCP/IP Thread.
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
Interfejs API platformy, który będzie wywoływany przez funkcję Warm, 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 przez funkcję Warm w celu dodania lub usunięcia adresu IP hosta do określonego interfejsu w stosie TCP/IP hosta.

Po zakończeniu działania platforma musi wywołać funkcję ReportActionComplete z ostatecznym wynikiem.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do zmodyfikowania.
[in] inAddress
Adres IP do dodania lub usunięcia.
[in] inPrefixLength
Długość prefiksu InAddress.
[in] inAdd
true (prawda), aby dodać adres, i false, aby go usunąć.
Zwracane wartości
kPlatformResultSuccess
Operacja zakończyła się pomyślnie.
kPlatformResultFailure
Operacja się nie udała.
kPlatformResultInProgress
Operacja zakończy się asynchronicznie.

AddRemoveHostRoute

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

Interfejs API platformy, który będzie wywoływany przez funkcję Warm w celu dodania lub usunięcia trasy IP dla określonego interfejsu w stosie TCP/IP hosta.

Po zakończeniu działania platforma musi wywołać funkcję ReportActionComplete z ostatecznym wynikiem.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do zmodyfikowania.
[in] inPrefix
Prefiks adresu IP do dodania lub usunięcia.
[in] inPriority
Priorytet używany podczas przypisywania trasy.
[in] inAdd
true (prawda), aby dodać prefiks jako trasę, lub „false”, aby go usunąć.
Zwracane wartości
kPlatformResultSuccess
Operacja zakończyła się pomyślnie.
kPlatformResultFailure
Operacja się nie udała.
kPlatformResultInProgress
Operacja zakończy się asynchronicznie.

AddRemoveThreadAddress

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

Interfejs API platformy, który będzie wywoływany przez funkcję Warm w celu dodania lub usunięcia adresu IP do określonego interfejsu w stosie TCP/IP Thread.

Po zakończeniu działania platforma musi wywołać funkcję ReportActionComplete z ostatecznym wynikiem.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do zmodyfikowania.
[in] inAddress
Adres IP do dodania lub usunięcia.
[in] inAdd
true (prawda), aby dodać adres, i false, aby go usunąć.
Zwracane wartości
kPlatformResultSuccess
Operacja zakończyła się pomyślnie.
kPlatformResultFailure
Operacja się nie udała.
kPlatformResultInProgress
Operacja zakończy się asynchronicznie.

AddRemoveThreadRoute

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

Interfejs API platformy, który będzie wywoływany przez funkcję Warm w celu dodania lub usunięcia trasy IP dla określonego interfejsu w stosie TCP/IP Thread.

Po zakończeniu działania platforma musi wywołać funkcję ReportActionComplete z ostatecznym wynikiem.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do zmodyfikowania.
[in] inPrefix
Prefiks adresu IP do przypisania / usunięcia.
[in] inPriority
Priorytet używany podczas przypisywania trasy.
[in] inAdd
true (prawda), aby dodać prefiks jako trasę, lub „false”, aby go usunąć.
Zwracane wartości
kPlatformResultSuccess
Operacja zakończyła się pomyślnie.
kPlatformResultFailure
Operacja się nie udała.
kPlatformResultInProgress
Operacja zakończy się asynchronicznie.

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

Interfejs API platformy, który będzie wywoływany przez funkcję Warm w celu ochrony dostępu do wewnętrznego stanu.

CriticalSectionExit

void CriticalSectionExit(
  void
)

Interfejs API platformy, który będzie wywoływany przez funkcję Warm w celu udostępnienia chronionego dostępu do stanu wewnętrznego.

Init

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

Interfejs API platformy, który zostanie wywołany przez Warm w ramach wykonania kodu nl::Warm::Init.

Szczegóły
Parametry
[in] inFabricStateDelegate
Wskaźnik do obiektu FabricStateDelegate używanego przez Warm do otrzymywania aktualizacji stanu tkanin.
Zwroty
WEAVE_NO_ERROR w przypadku powodzenia, kod błędu w przeciwnym razie

RequestInvokeActions

void RequestInvokeActions(
  void
)

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

.

SetThreadRoutePriority

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

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

Po zakończeniu działania platforma musi wywołać funkcję ReportActionComplete z ostatecznym wynikiem.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do zmodyfikowania.
[in] inPrefix
Prefiks adresu IP do zmodyfikowania.
[in] inPriority
Nowy priorytet stosowany do trasy.
Zwracane wartości
kPlatformResultSuccess
Operacja zakończyła się pomyślnie.
kPlatformResultFailure
Operacja się nie udała.
kPlatformResultInProgress
Operacja zakończy się asynchronicznie.

StartStopThreadAdvertisement

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

Interfejs API platformy, który będzie wywoływany przez funkcję Warm, aby uruchomić lub zatrzymać reklamowanie prefiksu IP w interfejsie Thread.

Po zakończeniu działania platforma musi wywołać funkcję ReportActionComplete z ostatecznym wynikiem.

Szczegóły
Parametry
[in] inInterfaceType
Interfejs do zmodyfikowania.
[in] inPrefix
Prefiks adresu IP, dla którego należy rozpocząć lub zakończyć wyświetlanie reklam.
[in] inStart
Wartość „true” (prawda), aby rozpocząć wyświetlanie reklam, lub „false” (fałsz), aby zatrzymać wyświetlanie reklam.
Zwracane wartości
kPlatformResultSuccess
Operacja zakończyła się pomyślnie.
kPlatformResultFailure
Operacja się nie udała.
kPlatformResultInProgress
Operacja zakończy się asynchronicznie.