nl::Weave::Warm::Platform

Zusammenfassung

Funktionen

AddRemoveHostAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, uint8_t inPrefixLength, bool inAdd)
Eine Plattform-API, die von Warm aufgerufen wird, um eine Host-IP-Adresse zur angegebenen Schnittstelle im Host-TCP/IP-Stack hinzuzufügen oder zu entfernen.
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Eine Plattform-API, die von Warm aufgerufen wird, um eine IP-Route für die angegebene Schnittstelle im TCP/IP-Stack des Hosts hinzuzufügen oder zu entfernen.
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
Eine Plattform-API, die von Warm aufgerufen wird, um eine IP-Adresse zur angegebenen Schnittstelle im Thread-TCP/IP-Stack hinzuzufügen oder zu entfernen.
AddRemoveThreadRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Eine Plattform-API, die von Warm aufgerufen wird, um eine IP-Route für die angegebene Schnittstelle im Thread-TCP/IP-Stack hinzuzufügen oder zu entfernen.
CriticalSectionEnter(void)
void
Eine Plattform-API, die von Warm aufgerufen wird, um den Zugriff auf den internen Status zu schützen.
CriticalSectionExit(void)
void
Eine Plattform-API, die von Warm aufgerufen wird, um den geschützten Zugriff auf den internen Status freizugeben.
Init(WarmFabricStateDelegate *inFabricStateDelegate)
Eine Plattform-API, die Warm als Teil der Ausführung von nl::Warm::Init aufruft.
RequestInvokeActions(void)
void
Eine Plattform-API, die von Warm aufgerufen wird, um mitzuteilen, dass die Plattform InvokeActions aufrufen soll.
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
Eine von Warm aufgerufene Plattform-API, um die Priorität einer vorhandenen IP-Route für die angegebene Schnittstelle im Thread-TCP/IP-Stack zu ändern.
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
Eine Plattform-API, die von Warm aufgerufen wird, um das Advertising eines IP-Präfixes auf der Thread-Schnittstelle zu starten oder zu stoppen.

Funktionen

AddRemoveHostAddress

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

Eine Plattform-API, die von Warm aufgerufen wird, um eine Host-IP-Adresse zur angegebenen Schnittstelle im Host-TCP/IP-Stack hinzuzufügen oder zu entfernen.

Nach Abschluss des Vorgangs muss die Plattform ReportActionComplete mit dem Endergebnis aufrufen.

Details
Parameter
[in] inInterfaceType
Die zu ändernde Schnittstelle.
[in] inAddress
Die IP-Adresse, die hinzugefügt/entfernt werden soll.
[in] inPrefixLength
Die Präfixlänge der inAddress.
[in] inAdd
true, um die Adresse hinzuzufügen, false, um sie zu entfernen.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Der Vorgang ist fehlgeschlagen.
kPlatformResultInProgress
Der Vorgang wird asynchron abgeschlossen.

AddRemoveHostRoute

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

Eine Plattform-API, die von Warm aufgerufen wird, um eine IP-Route für die angegebene Schnittstelle im TCP/IP-Stack des Hosts hinzuzufügen oder zu entfernen.

Nach Abschluss des Vorgangs muss die Plattform ReportActionComplete mit dem Endergebnis aufrufen.

Details
Parameter
[in] inInterfaceType
Die zu ändernde Schnittstelle.
[in] inPrefix
Das IP-Präfix, das hinzugefügt oder entfernt werden soll.
[in] inPriority
Die Priorität, die beim Zuweisen der Route verwendet werden soll.
[in] inAdd
true, um das Präfix als Route hinzuzufügen, und false, um es als Route zu entfernen.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Der Vorgang ist fehlgeschlagen.
kPlatformResultInProgress
Der Vorgang wird asynchron abgeschlossen.

AddRemoveThreadAddress

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

Eine Plattform-API, die von Warm aufgerufen wird, um eine IP-Adresse zur angegebenen Schnittstelle im Thread-TCP/IP-Stack hinzuzufügen oder zu entfernen.

Nach Abschluss des Vorgangs muss die Plattform ReportActionComplete mit dem Endergebnis aufrufen.

Details
Parameter
[in] inInterfaceType
Die zu ändernde Schnittstelle.
[in] inAddress
Die IP-Adresse, die hinzugefügt/entfernt werden soll.
[in] inAdd
true, um die Adresse hinzuzufügen, false, um sie zu entfernen.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Der Vorgang ist fehlgeschlagen.
kPlatformResultInProgress
Der Vorgang wird asynchron abgeschlossen.

AddRemoveThreadRoute

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

Eine Plattform-API, die von Warm aufgerufen wird, um eine IP-Route für die angegebene Schnittstelle im Thread-TCP/IP-Stack hinzuzufügen oder zu entfernen.

Nach Abschluss des Vorgangs muss die Plattform ReportActionComplete mit dem Endergebnis aufrufen.

Details
Parameter
[in] inInterfaceType
Die zu ändernde Schnittstelle.
[in] inPrefix
Das IP-Präfix, das zugewiesen oder entfernt werden soll.
[in] inPriority
Die Priorität, die beim Zuweisen der Route verwendet werden soll.
[in] inAdd
true, um das Präfix als Route hinzuzufügen, und false, um es als Route zu entfernen.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Der Vorgang ist fehlgeschlagen.
kPlatformResultInProgress
Der Vorgang wird asynchron abgeschlossen.

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

Eine Plattform-API, die von Warm aufgerufen wird, um den Zugriff auf den internen Status zu schützen.

CriticalSectionExit

void CriticalSectionExit(
  void
)

Eine Plattform-API, die von Warm aufgerufen wird, um den geschützten Zugriff auf den internen Status freizugeben.

Init

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

Eine Plattform-API, die Warm als Teil der Ausführung von nl::Warm::Init aufruft.

Details
Parameter
[in] inFabricStateDelegate
Ein Zeiger auf das FabricStateDelegate-Objekt, das von Warm zum Empfang von Updates für den Fabric-Status verwendet wird.
Rückgabe
WEAVE_NO_ERROR bei Erfolg, andernfalls Fehlercode.

RequestInvokeActions

void RequestInvokeActions(
  void
)

Eine Plattform-API, die von Warm aufgerufen wird, um mitzuteilen, dass die Plattform InvokeActions aufrufen soll.

.

SetThreadRoutePriority

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

Eine von Warm aufgerufene Plattform-API, um die Priorität einer vorhandenen IP-Route für die angegebene Schnittstelle im Thread-TCP/IP-Stack zu ändern.

Nach Abschluss des Vorgangs muss die Plattform ReportActionComplete mit dem Endergebnis aufrufen.

Details
Parameter
[in] inInterfaceType
Die zu ändernde Schnittstelle.
[in] inPrefix
Das zu ändernde IP-Präfix.
[in] inPriority
Die neue Priorität, die auf die Route angewendet werden soll.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Der Vorgang ist fehlgeschlagen.
kPlatformResultInProgress
Der Vorgang wird asynchron abgeschlossen.

StartStopThreadAdvertisement

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

Eine Plattform-API, die von Warm aufgerufen wird, um das Advertising eines IP-Präfixes auf der Thread-Schnittstelle zu starten oder zu stoppen.

Nach Abschluss des Vorgangs muss die Plattform ReportActionComplete mit dem Endergebnis aufrufen.

Details
Parameter
[in] inInterfaceType
Die zu ändernde Schnittstelle.
[in] inPrefix
Das IP-Präfix, für das Werbung gestartet oder gestoppt werden soll.
[in] inStart
true, um mit der Werbung zu beginnen, false, um die Werbung zu beenden.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Der Vorgang ist fehlgeschlagen.
kPlatformResultInProgress
Der Vorgang wird asynchron abgeschlossen.