Fehlermeldung

Dieses Modul enthält Funktionen, mit denen OpenThread-Nachrichtenzwischenspeicher manipuliert werden.

Zusammenfassung

Aufzählungen

otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
}
enum
Mit dieser Aufzählung werden die Prioritäten der OpenThread-Nachrichtenpriorität definiert.

Typdef.

otBufferInfo Typdef
struct otBufferInfo
Diese Struktur stellt die Nachrichtenzwischenspeicher-Informationen für verschiedene Warteschlangen dar, die vom OpenThread-Stack verwendet werden.
otMessage Typdef
struct otMessage
Dieser Typ ist eine undurchsichtige Darstellung eines OpenThread-Nachrichtenzwischenspeichers.
otMessagePriority Typdef
Mit dieser Aufzählung werden die Prioritäten der OpenThread-Nachrichtenpriorität definiert.
otMessageQueueInfo Typdef
Diese Struktur stellt Informationen über eine Nachrichtenwarteschlange dar.
otMessageSettings Typdef
Diese Struktur stellt eine Nachrichteneinstellung dar.

Funktionen

otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
Hängen Sie Bytes an eine Nachricht an.
otMessageFree(otMessage *aMessage)
void
Freigegebenen Nachrichtenzwischenspeicher freigeben.
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Rufen Sie die Informationen des Nachrichtenzwischenspeichers ab.
otMessageGetLength(const otMessage *aMessage)
uint16_t
Rufe die Nachrichtenlänge in Byte ab.
otMessageGetOffset(const otMessage *aMessage)
uint16_t
Nachrichtenversatz in Byte abrufen.
otMessageGetRss(const otMessage *aMessage)
int8_t
Diese Funktion gibt den durchschnittlichen RSS-Wert (Empfangen des Signals) zurück, der mit der Nachricht verknüpft ist.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
Mit dieser Funktion wird angegeben, ob die Linksicherheit für die Nachricht aktiviert ist.
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
void
Mit dieser Funktion wird eine Nachricht aus der angegebenen Nachrichtenwarteschlange entfernt.
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
void
Diese Funktion fügt eine Nachricht am Ende der angegebenen Nachrichtenwarteschlange hinzu.
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
void
Durch diese Funktion wird eine Nachricht am Anfang/Vorder der bestimmten Nachrichtenwarteschlange hinzugefügt.
otMessageQueueGetHead(otMessageQueue *aQueue)
Diese Funktion gibt einen Zeiger auf die Nachricht am Anfang der Warteschlange zurück.
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
Diese Funktion gibt einen Zeiger zur nächsten Nachricht in der Warteschlange zurück, indem er von sich ausgehend (von Kopf bis Ende) iteriert.
otMessageQueueInit(otMessageQueue *aQueue)
void
Initialisieren Sie die Nachrichtenwarteschlange.
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Byte aus einer Nachricht lesen.
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
void
Durch diese Funktion wird festgelegt, dass die Nachricht per Direktübertragung weitergeleitet wird.
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
Legen Sie die Nachrichtenlänge in Byte fest.
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
void
Die Nachrichtenabweichung in Byte festlegen.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Byte in Nachricht schreiben.

Strebenklemmen

otBufferInfo

Diese Struktur stellt die Nachrichtenzwischenspeicher-Informationen für verschiedene Warteschlangen dar, die vom OpenThread-Stack verwendet werden.

otMessageQueue

Diese Struktur stellt eine OpenThread-Nachrichtenwarteschlange dar.

otMessageQueueInfo

Diese Struktur stellt Informationen über eine Nachrichtenwarteschlange dar.

otMessageSettings

Diese Struktur stellt eine Nachrichteneinstellung dar.

Aufzählungen

otMessagePriority

 otMessagePriority

Mit dieser Aufzählung werden die Prioritäten der OpenThread-Nachrichtenpriorität definiert.

Attribute
OT_MESSAGE_PRIORITY_HIGH

Eine hohe Prioritätsebene.

OT_MESSAGE_PRIORITY_LOW

Weniger wichtig.

OT_MESSAGE_PRIORITY_NORMAL

Normale Prioritätsebene.

Typdef.

Logo: otBufferInfo

struct otBufferInfo otBufferInfo

Diese Struktur stellt die Nachrichtenzwischenspeicher-Informationen für verschiedene Warteschlangen dar, die vom OpenThread-Stack verwendet werden.

OTMessage

struct otMessage otMessage

Dieser Typ ist eine undurchsichtige Darstellung eines OpenThread-Nachrichtenzwischenspeichers.

otMessagePriority

enum otMessagePriority otMessagePriority

Mit dieser Aufzählung werden die Prioritäten der OpenThread-Nachrichtenpriorität definiert.

OTMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

Diese Struktur stellt Informationen über eine Nachrichtenwarteschlange dar.

otMessageSettings

struct otMessageSettings otMessageSettings

Diese Struktur stellt eine Nachrichteneinstellung dar.

Funktionen

OTMessageAnhängen

otError otMessageAppend(
  otMessage *aMessage,
  const void *aBuf,
  uint16_t aLength
)

Hängen Sie Bytes an eine Nachricht an.

Details
Parameter
[in] aMessage
Ein Zeiger auf einen Nachrichtenzwischenspeicher.
[in] aBuf
Ein Zeiger auf die Daten, die angefügt werden sollen.
[in] aLength
Anzahl der anzuhängenden Byte.
Rückgabewerte
OT_ERROR_NONE
Nachricht wurde angehängt
OT_ERROR_NO_BUFS
Keine verfügbaren Zwischenspeicher für die Erweiterung der Nachricht.
Weitere Informationen:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

OTMessageFree

void otMessageFree(
  otMessage *aMessage
)

Freigegebenen Nachrichtenzwischenspeicher freigeben.

Details
Parameter
[in] aMessage
Ein Zeiger auf einen Nachrichtenzwischenspeicher.
Weitere Informationen:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Rufen Sie die Informationen des Nachrichtenzwischenspeichers ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf die OpenThread-Instanz.
[out] aBufferInfo
Ein Zeiger, in den die Zwischenspeicherinformationen der Nachricht geschrieben werden.

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Rufe die Nachrichtenlänge in Byte ab.

Details
Parameter
[in] aMessage
Ein Zeiger auf einen Nachrichtenzwischenspeicher.
Rückgabe
Die Nachrichtenlänge in Byte.
Weitere Informationen:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Nachrichtenversatz in Byte abrufen.

Details
Parameter
[in] aMessage
Ein Zeiger auf einen Nachrichtenzwischenspeicher.
Rückgabe
Der Versatz der Nachricht.
Weitere Informationen:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Diese Funktion gibt den durchschnittlichen RSS-Wert (Empfangen des Signals) zurück, der mit der Nachricht verknüpft ist.

Details
Rückgabe
Durchschnittlicher RSS-Wert (in dBm) oder OT_RADIO_RSSI_INVALID, wenn kein durchschnittlicher RSS-Wert verfügbar ist.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Mit dieser Funktion wird angegeben, ob die Linksicherheit für die Nachricht aktiviert ist.

Details
Parameter
[in] aMessage
Ein Zeiger auf einen Nachrichtenzwischenspeicher.
Rückgabewerte
TRUE
Wenn die Link-Sicherheit aktiviert ist.
FALSE
Wenn die Linksicherheit nicht aktiviert ist.

otMessageQueueDeQueue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Mit dieser Funktion wird eine Nachricht aus der angegebenen Nachrichtenwarteschlange entfernt.

Details
Parameter
[in] aQueue
Ein Zeiger auf die Nachrichtenwarteschlange.
[in] aMessage
Die zu entfernende Nachricht

otMessageQueueEnwarteschlange

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Diese Funktion fügt eine Nachricht am Ende der angegebenen Nachrichtenwarteschlange hinzu.

Details
Parameter
[in] aQueue
Ein Zeiger auf die Nachrichtenwarteschlange.
[in] aMessage
Die hinzuzufügende Nachricht

otMessageQueueEnQueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Durch diese Funktion wird eine Nachricht am Anfang/Vorder der bestimmten Nachrichtenwarteschlange hinzugefügt.

Details
Parameter
[in] aQueue
Ein Zeiger auf die Nachrichtenwarteschlange.
[in] aMessage
Die hinzuzufügende Nachricht

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Diese Funktion gibt einen Zeiger auf die Nachricht am Anfang der Warteschlange zurück.

Details
Parameter
[in] aQueue
Der Mauszeiger auf eine Nachrichtenwarteschlange.
Rückgabe
Ein Zeiger auf die Nachricht am Anfang der Warteschlange oder NULL, wenn die Warteschlange leer ist.

otMessageQueueGetNext

otMessage * otMessageQueueGetNext(
  otMessageQueue *aQueue,
  const otMessage *aMessage
)

Diese Funktion gibt einen Zeiger zur nächsten Nachricht in der Warteschlange zurück, indem er von sich ausgehend (von Kopf bis Ende) iteriert.

Details
Parameter
[in] aQueue
Der Mauszeiger auf eine Nachrichtenwarteschlange.
[in] aMessage
Ein Zeiger auf den aktuellen Nachrichtenzwischenspeicher.
Rückgabe
Ein Zeiger auf die nächste Nachricht in der Warteschlange nach aMessage oder NULL, wenn aMessage is the tail of queue. NULL is returned ifaMessageis not in the queueaQueue`.

OTMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Initialisieren Sie die Nachrichtenwarteschlange.

Diese Funktion muss für eine otMessageQueue-Instanz nur einmal und vor allen anderen otMessageQueue-Funktionen aufgerufen werden. Die Funktionsweise ist nicht definiert, wenn andere Warteschlangen-APIs vor der Initialisierung mit einem otMessageQueue verwendet werden oder wenn sie mehrmals initialisiert wird.

Details
Parameter
[in] aQueue
Der Mauszeiger auf eine Nachrichtenwarteschlange.

OTMessageRead

uint16_t otMessageRead(
  const otMessage *aMessage,
  uint16_t aOffset,
  void *aBuf,
  uint16_t aLength
)

Byte aus einer Nachricht lesen.

Details
Parameter
[in] aMessage
Ein Zeiger auf einen Nachrichtenzwischenspeicher.
[in] aOffset
Eine Abweichung in Byte.
[in] aBuf
Ein Zeiger auf einen Zwischenspeicher, in den Bytes gelesen werden.
[in] aLength
Anzahl der zu lesenden Byte.
Rückgabe
Die Anzahl der gelesenen Byte.
Weitere Informationen:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Durch diese Funktion wird festgelegt, dass die Nachricht per Direktübertragung weitergeleitet wird.

Die Standardeinstellung für eine neue Nachricht ist false.

Details
Parameter
[in] aMessage
Ein Zeiger auf einen Nachrichtenzwischenspeicher.
[in] aEnabled
Bei true wird die direkte Übertragung der Nachricht erzwungen. Für false wird die normale Vorgehensweise angewendet.

otMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Legen Sie die Nachrichtenlänge in Byte fest.

Details
Parameter
[in] aMessage
Ein Zeiger auf einen Nachrichtenzwischenspeicher.
[in] aLength
Länge in Byte.
Rückgabewerte
OT_ERROR_NONE
Nachrichtenlänge wurde festgelegt.
OT_ERROR_NO_BUFS
Keine verfügbaren Zwischenspeicher für die Erweiterung der Nachricht.
Weitere Informationen:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Die Nachrichtenabweichung in Byte festlegen.

Details
Parameter
[in] aMessage
Ein Zeiger auf einen Nachrichtenzwischenspeicher.
[in] aOffset
Eine Abweichung in Byte.
Weitere Informationen:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

OTMessageWrite

int otMessageWrite(
  otMessage *aMessage,
  uint16_t aOffset,
  const void *aBuf,
  uint16_t aLength
)

Byte in Nachricht schreiben.

Details
Parameter
[in] aMessage
Ein Zeiger auf einen Nachrichtenzwischenspeicher.
[in] aOffset
Eine Abweichung in Byte.
[in] aBuf
Ein Zeiger auf einen Puffer, aus dem Nachrichtenbytes geschrieben werden.
[in] aLength
Anzahl der zu schreibenden Byte.
Rückgabe
Die Anzahl der geschriebenen Byte.
Weitere Informationen:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

Ressourcen

Die Themen der API-Referenz zur OpenThread API stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen sowie die Möglichkeit, in unserer Dokumentation mitzuwirken, finden Sie unter Ressourcen.