UDP
Dieses Modul enthält Funktionen, die die UDP-Kommunikation steuern.
Zusammenfassung
Aufzählungen |
|
---|---|
otNetifIdentifier{
|
enum Diese Aufzählung definiert die Kennungen der OpenThread-Netzwerkschnittstelle. |
Typdefekt |
|
---|---|
otNetifIdentifier
|
typedefenum otNetifIdentifier
Diese Aufzählung definiert die Kennungen der OpenThread-Netzwerkschnittstelle. |
otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
typedefbool(*
Mit diesem Callback kann OpenThread bestimmte Handler für bestimmte UDP-Nachrichten bereitstellen. |
otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
typedefvoid(*
Mit diesem Callback kann OpenThread die Anwendung einer empfangenen UDP-Nachricht informieren. |
otUdpReceiver
|
typedefstruct otUdpReceiver
Diese Struktur stellt einen UDP-Empfänger dar. |
otUdpSocket
|
typedefstruct otUdpSocket
Diese Struktur stellt einen UDP-Socket dar. |
Funktionen |
|
---|---|
otUdpAddReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
|
Durch diese Funktion wird ein UDP-Empfänger hinzugefügt.
|
otUdpBind(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif)
|
Binden Sie einen UDP-/IPv6-Socket.
|
otUdpClose(otInstance *aInstance, otUdpSocket *aSocket)
|
Schließen Sie einen UDP/IPv6-Socket.
|
otUdpConnect(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName)
|
Verbinden Sie einen UDP-/IPv6-Socket.
|
otUdpGetSockets(otInstance *aInstance)
|
Diese Funktion ruft den Header der verknüpften Liste von UDP-Sockets ab.
|
otUdpIsOpen(otInstance *aInstance, const otUdpSocket *aSocket)
|
bool
Prüfen Sie, ob ein UDP-Socket geöffnet ist.
|
otUdpNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
|
Ordnen Sie einen neuen Zwischenspeicher für Nachrichten zu, um eine UDP-Nachricht zu senden.
|
otUdpOpen(otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext)
|
Öffnen Sie einen UDP-/IPv6-Socket.
|
otUdpRemoveReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
|
Diese Funktion entfernt einen UDP-Empfänger.
|
otUdpSend(otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
Senden Sie eine UDP-/IPv6-Nachricht.
|
otUdpSendDatagram(otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo)
|
Diese Funktion sendet eine UDP-Nachricht ohne Socket.
|
Bauwerke |
|
---|---|
otUdpReceiver |
Diese Struktur stellt einen UDP-Empfänger dar. |
otUdpSocket |
Diese Struktur stellt einen UDP-Socket dar. |
Aufzählungen
otNetifIdentifier
otNetifIdentifier
Diese Aufzählung definiert die Kennungen der OpenThread-Netzwerkschnittstelle.
Attribute | |
---|---|
OT_NETIF_BACKBONE
|
Die Backbone-Schnittstelle |
OT_NETIF_THREAD
|
Die Thread-Oberfläche. |
OT_NETIF_UNSPECIFIED
|
Nicht angegebene Netzwerkschnittstelle. |
Typdefekt
otNetifIdentifier
enum otNetifIdentifier otNetifIdentifier
Diese Aufzählung definiert die Kennungen der OpenThread-Netzwerkschnittstelle.
otUdpHandler
bool(* otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)
Mit diesem Callback kann OpenThread bestimmte Handler für bestimmte UDP-Nachrichten bereitstellen.
Details | |||||
---|---|---|---|---|---|
Rückgabewerte |
|
otUdpReceive
void(* otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Mit diesem Callback kann OpenThread die Anwendung einer empfangenen UDP-Nachricht informieren.
Funktionen
otUdpAddReceiver
otError otUdpAddReceiver( otInstance *aInstance, otUdpReceiver *aUdpReceiver )
Durch diese Funktion wird ein UDP-Empfänger hinzugefügt.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
OTUdpBind
otError otUdpBind( otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif )
Binden Sie einen UDP-/IPv6-Socket.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otUdpClose
otError otUdpClose( otInstance *aInstance, otUdpSocket *aSocket )
Schließen Sie einen UDP/IPv6-Socket.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otUdpConnect
otError otUdpConnect( otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName )
Verbinden Sie einen UDP-/IPv6-Socket.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otUdpGetSockets
otUdpSocket * otUdpGetSockets( otInstance *aInstance )
Diese Funktion ruft den Header der verknüpften Liste von UDP-Sockets ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf den Header der verknüpften UDP-Socket-Liste.
|
otUdpIsOpen
bool otUdpIsOpen( otInstance *aInstance, const otUdpSocket *aSocket )
Prüfen Sie, ob ein UDP-Socket geöffnet ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
Ob der UDP-Socket geöffnet ist.
|
otUdpNewMessage
otMessage * otUdpNewMessage( otInstance *aInstance, const otMessageSettings *aSettings )
Ordnen Sie einen neuen Zwischenspeicher für Nachrichten zu, um eine UDP-Nachricht zu senden.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
Ein Zeiger auf den Nachrichtenpuffer oder NULL, wenn keine Nachrichtenpuffer verfügbar sind oder die Parameter ungültig sind.
|
otMessageFree
otUdpOpen
otError otUdpOpen( otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext )
Öffnen Sie einen UDP-/IPv6-Socket.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otUdpRemoveReceiver
otError otUdpRemoveReceiver( otInstance *aInstance, otUdpReceiver *aUdpReceiver )
Diese Funktion entfernt einen UDP-Empfänger.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otUdpSend
otError otUdpSend( otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo )
Senden Sie eine UDP-/IPv6-Nachricht.
Wenn der Rückgabewert OT_ERROR_NONE lautet, übernimmt OpenThread die Inhaberschaft von aMessage
und der Aufrufer sollte nicht mehr auf aMessage
verweisen. Wenn der Rückgabewert nicht OT_ERROR_NONE lautet, behält der Aufrufer die Inhaberschaft von aMessage
bei und gibt aMessage
frei, wenn der Nachrichtenpuffer nicht mehr benötigt wird.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
Details | |||||||
---|---|---|---|---|---|---|---|
Rückgabewerte |
|
otUdpSendDatagram
otError otUdpSendDatagram( otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo )
Diese Funktion sendet eine UDP-Nachricht ohne Socket.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
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.