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 der 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 auf dem Host-TCP/IP-Stack hinzuzufügen oder zu entfernen.
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
Eine Plattform-API, die von Warm aufgerufen wird, um der angegebenen Schnittstelle im TCP/IP-Stack eine IP-Adresse 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 von Warm im Rahmen der Ausführung von nl::Warm::Init aufgerufen wird.
RequestInvokeActions(void)
void
Eine Plattform-API, die Warm aufruft, um anzukündigen, dass die Plattform InvokeActions aufrufen soll.
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
Eine Plattform-API, die von Warm aufgerufen wird, 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 / 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 der 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 oder entfernt werden soll.
[in] inPrefixLength
Die Präfixlänge von inAddress.
[in] inAdd
true zum Hinzufügen der Adresse, false , um die Adresse zu entfernen.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Bei dem Vorgang ist ein Fehler aufgetreten.
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 auf dem 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] inPrefix
Das IP-Präfix, das hinzugefügt bzw. entfernt werden soll.
[in] inPriority
Die zu verwendende Priorität, wenn die Route zugewiesen wird.
[in] inAdd
"true", um das Präfix als Route hinzuzufügen, und "false", um das Präfix als Route zu entfernen.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Bei dem Vorgang ist ein Fehler aufgetreten.
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 der angegebenen Schnittstelle im TCP/IP-Stack eine IP-Adresse 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 oder entfernt werden soll.
[in] inAdd
true zum Hinzufügen der Adresse, false , um die Adresse zu entfernen.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Bei dem Vorgang ist ein Fehler aufgetreten.
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 bzw. entfernt werden soll.
[in] inPriority
Die zu verwendende Priorität, wenn die Route zugewiesen wird.
[in] inAdd
"true", um das Präfix als Route hinzuzufügen, und "false", um das Präfix als Route zu entfernen.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Bei dem Vorgang ist ein Fehler aufgetreten.
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 von Warm im Rahmen der Ausführung von nl::Warm::Init aufgerufen wird.

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

RequestInvokeActions

void RequestInvokeActions(
  void
)

Eine Plattform-API, die Warm aufruft, um anzukündigen, dass die Plattform InvokeActions aufrufen soll.

SetThreadRoutePriority

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

Eine Plattform-API, die von Warm aufgerufen wird, 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
Bei dem Vorgang ist ein Fehler aufgetreten.
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 / 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 die Werbung gestartet bzw. beendet werden soll.
[in] inStart
"true", um die Anzeigenschaltung zu starten, und "false", um die Anzeigenschaltung zu beenden.
Rückgabewerte
kPlatformResultSuccess
Der Vorgang wurde erfolgreich abgeschlossen.
kPlatformResultFailure
Bei dem Vorgang ist ein Fehler aufgetreten.
kPlatformResultInProgress
Der Vorgang wird asynchron abgeschlossen.