UDP

Ten moduł zawiera funkcje sterujące komunikacją UDP.

Podsumowanie

Wyliczenia

otNetifIdentifier{
  OT_NETIF_UNSPECIFIED = 0,
  OT_NETIF_THREAD,
  OT_NETIF_BACKBONE
}
enum | typ wyliczeniowy
To wyliczenie określa identyfikatory interfejsu sieciowego OpenThread.

Typedefs

otNetifIdentifier typedef
To wyliczenie określa identyfikatory interfejsu sieciowego OpenThread.
otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
bool(*
Wywołanie zwrotne pozwala OpenThread przydzielić określone moduły obsługi niektórych wiadomości UDP.
otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
Wywołanie zwrotne pozwala usłudze OpenThread, aby poinformować aplikację o otrzymanej wiadomości UDP.
otUdpReceiver typedef
struct otUdpReceiver
Ta struktura reprezentuje odbiornik UDP.
otUdpSocket typedef
struct otUdpSocket
Ta struktura reprezentuje gniazdo UDP.

Funkcje

otUdpAddReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
Ta funkcja dodaje odbiornik UDP.
otUdpBind(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif)
Powiąż gniazdo UDP/IPv6.
otUdpClose(otInstance *aInstance, otUdpSocket *aSocket)
Zamknij gniazdo UDP/IPv6.
otUdpConnect(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName)
Podłącz gniazdo UDP/IPv6.
otUdpGetSockets(otInstance *aInstance)
Ta funkcja pobiera nagłówek połączonej listy gniazd UDP.
otUdpIsOpen(otInstance *aInstance, const otUdpSocket *aSocket)
bool
Sprawdź, czy gniazdo UDP jest otwarte.
otUdpNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
Przydziel nowy bufor wiadomości do wysyłania wiadomości UDP.
otUdpOpen(otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext)
Otwórz gniazdo UDP/IPv6.
otUdpRemoveReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
Ta funkcja usuwa odbiornik UDP.
otUdpSend(otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Wyślij wiadomość UDP/IPv6.
otUdpSendDatagram(otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo)
Ta funkcja wysyła wiadomość UDP bez gniazda.

Strugi

otUdpReceiver

Ta struktura reprezentuje odbiornik UDP.

otUdpSocket

Ta struktura reprezentuje gniazdo UDP.

Wyliczenia

otNetifIdentifier

 otNetifIdentifier

To wyliczenie określa identyfikatory interfejsu sieciowego OpenThread.

Właściwości
OT_NETIF_BACKBONE

Interfejs Backbone.

OT_NETIF_THREAD

Interfejs Thread.

OT_NETIF_UNSPECIFIED

Nieokreślony interfejs sieci.

Typedefs

otNetifIdentifier

enum otNetifIdentifier otNetifIdentifier

To wyliczenie określa identyfikatory interfejsu sieciowego OpenThread.

Funkcja UtUdpHandler

bool(* otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)

Wywołanie zwrotne pozwala OpenThread przydzielić określone moduły obsługi niektórych wiadomości UDP.

Szczegóły
Zwracane wartości
true
Wiadomość jest obsługiwana przez tego odbiorcę i nie powinna być dalej przetwarzana.
false
Ten odbiornik nie obsługuje tej wiadomości.

OTUdpReceive

void(* otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)

Wywołanie zwrotne pozwala usłudze OpenThread, aby poinformować aplikację o otrzymanej wiadomości UDP.

Odbiornik OTU

struct otUdpReceiver otUdpReceiver

Ta struktura reprezentuje odbiornik UDP.

zwyczajny Przejrzyj

struct otUdpSocket otUdpSocket

Ta struktura reprezentuje gniazdo UDP.

Funkcje

OTUdpAddReceiver

otError otUdpAddReceiver(
  otInstance *aInstance,
  otUdpReceiver *aUdpReceiver
)

Ta funkcja dodaje odbiornik UDP.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aUdpReceiver
Wskaźnik odbiornika UDP.
Zwracane wartości
OT_ERROR_NONE
Odbiorca został dodany.
OT_ERROR_ALREADY
Odbiorca UDP został już dodany.

otUdpBind

otError otUdpBind(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  const otSockAddr *aSockName,
  otNetifIdentifier aNetif
)

Powiąż gniazdo UDP/IPv6.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aSocket
Wskaźnik struktury gniazd UDP.
[in] aSockName
Wskaźnik struktury adresów IPv6.
[in] aNetif
Interfejs sieciowy do powiązania.
Zwracane wartości
OT_ERROR_NONE
Powiązanie zostało zakończone.
OT_ERROR_FAILED
Nie udało się powiązać gniazda UDP.

og

otError otUdpClose(
  otInstance *aInstance,
  otUdpSocket *aSocket
)

Zamknij gniazdo UDP/IPv6.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aSocket
Wskaźnik struktury gniazd UDP.
Zwracane wartości
OT_ERROR_NONE
Gniazdko zostało zamknięte.
OT_ERROR_FAILED
Nie udało się zamknąć gniazda UDP.

OtUdpConnect

otError otUdpConnect(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  const otSockAddr *aSockName
)

Podłącz gniazdo UDP/IPv6.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aSocket
Wskaźnik struktury gniazd UDP.
[in] aSockName
Wskaźnik struktury adresów IPv6.
Zwracane wartości
OT_ERROR_NONE
Łączenie zostało zakończone.
OT_ERROR_FAILED
Nie udało się podłączyć gniazda UDP.

zwycznógSocketów

otUdpSocket * otUdpGetSockets(
  otInstance *aInstance
)

Ta funkcja pobiera nagłówek połączonej listy gniazd UDP.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik nagłówka połączonej listy UDP Socket.

otUdpIsOpen

bool otUdpIsOpen(
  otInstance *aInstance,
  const otUdpSocket *aSocket
)

Sprawdź, czy gniazdo UDP jest otwarte.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aSocket
Wskaźnik struktury gniazd UDP.
Zwroty
Określa, czy gniazdo UDP jest otwarte.

otUdpNewMessage

otMessage * otUdpNewMessage(
  otInstance *aInstance,
  const otMessageSettings *aSettings
)

Przydziel nowy bufor wiadomości do wysyłania wiadomości UDP.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aSettings
Wskaż ustawienia wiadomości lub wartość NULL, aby użyć ustawień domyślnych.
Zwroty
Wskaźnik bufora wiadomości lub wartość NULL, jeśli nie są dostępne bufory wiadomości lub parametry są nieprawidłowe.
Zobacz też:
otMessageFree

otUdpOpen

otError otUdpOpen(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  otUdpReceive aCallback,
  void *aContext
)

Otwórz gniazdo UDP/IPv6.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aSocket
Wskaźnik struktury gniazd UDP.
[in] aCallback
Wskaźnik funkcji wywołania zwrotnego aplikacji.
[in] aContext
Wskaźnik kontekstu aplikacji.
Zwracane wartości
OT_ERROR_NONE
gniazdo zostało otwarte.
OT_ERROR_FAILED
Nie można otworzyć gniazda.

OTUdpRemoveReceiver

otError otUdpRemoveReceiver(
  otInstance *aInstance,
  otUdpReceiver *aUdpReceiver
)

Ta funkcja usuwa odbiornik UDP.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aUdpReceiver
Wskaźnik odbiornika UDP.
Zwracane wartości
OT_ERROR_NONE
Adresat został usunięty.
OT_ERROR_NOT_FOUND
Odbiorca UDP nie został dodany.

OtUdpSend

otError otUdpSend(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo
)

Wyślij wiadomość UDP/IPv6.

Jeśli zwrócona wartość to OT_ERROR_NONE, OpenThread przejmuje własność aMessage, a wywołujący nie powinien już odwoływać się do aMessage. Jeśli zwracana wartość to nie OT_ERROR_NONE, element wywołujący zachowuje własność aMessage, w tym zwolniono aMessage, jeśli bufor wiadomości nie jest już potrzebny.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aSocket
Wskaźnik struktury gniazd UDP.
[in] aMessage
Wskaźnik bufora wiadomości.
[in] aMessageInfo
Wskaźnik informacji o wiadomości.

Szczegóły
Zwracane wartości
OT_ERROR_NONE
Zaplanowano wysłanie wiadomości.
OT_ERROR_INVALID_ARGS
Podano nieprawidłowe argumenty.
OT_ERROR_NO_BUFS
Niewystarczający dostępny bufor. Nie można dodać nagłówków UDP i IPv6.

otUdpSendDatagram

otError otUdpSendDatagram(
  otInstance *aInstance,
  otMessage *aMessage,
  otMessageInfo *aMessageInfo
)

Ta funkcja wysyła wiadomość UDP bez gniazda.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aMessage
Wskaźnik wiadomości bez nagłówka UDP.
[in] aMessageInfo
Wskaźnik informacji o wiadomości powiązanych z aMessage.
Zwracane wartości
OT_ERROR_NONE
Umieść wiadomość w kolejce w kolejce.
OT_ERROR_NO_BUFS
Niewystarczający dostępny bufor, by dodać nagłówki IPv6.

Zasoby

Tematy referencyjne interfejsu API OpenThread pochodzą z kodu źródłowego, który jest dostępny w GitHub. Jeśli chcesz dowiedzieć się więcej lub utworzyć dokumentację, zapoznaj się z materiałami.