Server

Dieses Modul enthält Funktionen zum Verwalten von lokalen Netzwerkdaten mit dem OpenThread Server.

Zusammenfassung

Funktionen

otServerAddService(otInstance *aInstance, const otServiceConfig *aConfig)
Dienstkonfiguration zu den lokalen Netzwerkdaten hinzufügen
otServerGetNetDataLocal(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Mit dieser Methode wird eine vollständige oder stabile Kopie der lokalen Thread-Netzwerkdaten bereitgestellt.
otServerGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Diese Funktion ruft den nächsten Dienst in den lokalen Netzwerkdaten ab.
otServerRegister(otInstance *aInstance)
Registrieren Sie sofort die lokalen Netzwerkdaten beim Leader.
otServerRemoveService(otInstance *aInstance, uint32_t aEnterpriseNumber, const uint8_t *aServiceData, uint8_t aServiceDataLength)
Entfernen Sie eine Dienstkonfiguration aus den lokalen Netzwerkdaten.

Funktionen

otServerAddService

otError otServerAddService(
  otInstance *aInstance,
  const otServiceConfig *aConfig
)

Dienstkonfiguration zu den lokalen Netzwerkdaten hinzufügen

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aConfig
Ein Zeiger auf die Dienstkonfiguration.
Rückgabewerte
OT_ERROR_NONE
Die Konfiguration wurde den lokalen Netzwerkdaten hinzugefügt.
OT_ERROR_INVALID_ARGS
Mindestens ein Konfigurationsparameter war ungültig.
OT_ERROR_NO_BUFS
Es ist nicht genügend Platz, um die Konfiguration den lokalen Netzwerkdaten hinzuzufügen.
Weitere Informationen:
otServerRemoveService
otServerRegister

otServerGetNetDataLocal

otError otServerGetNetDataLocal(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

Mit dieser Methode wird eine vollständige oder stabile Kopie der lokalen Thread-Netzwerkdaten bereitgestellt.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aStable
TRUE beim Kopieren der stabilen Version, FALSE beim Kopieren der Vollversion.
[out] aData
Ein Zeiger auf den Datenpuffer.
[in,out] aDataLength
Bei dem Eintrag entspricht die Größe des Datenpuffers, auf die aData verweist. Beim Beenden die Anzahl der kopierten Byte.

otServerGetNextService

otError otServerGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

Diese Funktion ruft den nächsten Dienst in den lokalen Netzwerkdaten ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in,out] aIterator
Ein Zeiger auf den Kontext des Netzwerkdaten-Iterators. Für den ersten Diensteintrag sollte OT_NETWORK_DATA_ITERATOR_INIT festgelegt werden.
[out] aConfig
Ein Zeiger auf die Stelle, an der die Dienstinformationen platziert werden.
Rückgabewerte
OT_ERROR_NONE
Nächster Dienst erfolgreich gefunden.
OT_ERROR_NOT_FOUND
In den Thread-Netzwerkdaten ist kein nachfolgender Dienst vorhanden.

otServerRegister

otError otServerRegister(
  otInstance *aInstance
)

Registrieren Sie sofort die lokalen Netzwerkdaten beim Leader.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
OT_ERROR_NONE
Serverdatenanfragenachricht wurde für die Zustellung erfolgreich in die Warteschlange gestellt.
Weitere Informationen:
otServerAddService
otServerRemoveService

otServerRemoveService

otError otServerRemoveService(
  otInstance *aInstance,
  uint32_t aEnterpriseNumber,
  const uint8_t *aServiceData,
  uint8_t aServiceDataLength
)

Entfernen Sie eine Dienstkonfiguration aus den lokalen Netzwerkdaten.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aEnterpriseNumber
Unternehmensnummer des zu löschenden Diensteintrags.
[in] aServiceData
Ein Zeiger auf eine Dienstdaten, die beim Löschen gesucht werden soll.
[in] aServiceDataLength
Die Länge von aServiceData in Byte.
Rückgabewerte
OT_ERROR_NONE
Die Konfiguration wurde aus den lokalen Netzwerkdaten entfernt.
OT_ERROR_NOT_FOUND
Der Border Router-Eintrag konnte nicht gefunden werden.
Weitere Informationen:
otServerAddService
otServerRegister

Ressourcen

Die OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen und einen Beitrag zu unserer Dokumentation finden Sie unter Ressourcen.