UDP

Ten moduł zawiera funkcje kontrolujące komunikację UDP.

Podsumowanie

Wyliczenia
otNetifIdentifier{
  OT_NETIF_UNSPECIFIED = 0,
  OT_NETIF_THREAD,
  OT_NETIF_BACKBONE
} 		enum | typ wyliczeniowy
Definiuje identyfikatory interfejsu sieciowego OpenThread.

Definicje typów
otNetifIdentifier typedef
Definiuje identyfikatory interfejsu sieciowego OpenThread.
otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
bool(*
To wywołanie zwrotne pozwala OpenThread udostępnić określone moduły obsługi niektórych wiadomości UDP.
otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
To wywołanie zwrotne pozwala OpenThread przekazać aplikacji o odebranej wiadomości UDP.
otUdpReceiver typedef
struct otUdpReceiver
Reprezentuje odbiornik UDP.
otUdpSocket typedef
struct otUdpSocket
Reprezentuje gniazdo UDP.

Funkcje
otUdpAddReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
Dodaje odbiornik UDP.
otUdpBind(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif)
Musisz powiązać 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)
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)
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)
Wysyła wiadomość UDP bez gniazda.

Konstrukcja
otUdpReceiver

Reprezentuje odbiornik UDP.

otUdpSocket

Reprezentuje gniazdo UDP.

Wyliczenia

otNetifIdentifier

 otNetifIdentifier

Definiuje 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.

Definicje typów

otNetifIdentifier

enum otNetifIdentifier otNetifIdentifier

Definiuje identyfikatory interfejsu sieciowego OpenThread.

otUdpHandler

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

To wywołanie zwrotne pozwala OpenThread udostępnić 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
Wiadomość nie jest obsługiwana przez tego odbiorcę.

otUdpReceive

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

To wywołanie zwrotne pozwala OpenThread przekazać aplikacji o odebranej wiadomości UDP.

otUdpReceiver

struct otUdpReceiver otUdpReceiver

Reprezentuje odbiornik UDP.

otUdpSocket

struct otUdpSocket otUdpSocket

Reprezentuje gniazdo UDP.

Funkcje

otUdpAddReceiver

otError otUdpAddReceiver(
  otInstance *aInstance,
  otUdpReceiver *aUdpReceiver
)

Dodaje odbiornik UDP.

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

otUdpBind

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

Musisz powiązać gniazdo UDP/IPv6.

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

otUdpClose

otError otUdpClose(
  otInstance *aInstance,
  otUdpSocket *aSocket
)

Zamknij gniazdo UDP/IPv6.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aSocket
Wskaźnik do struktury gniazd UDP.
Zwracane wartości
OT_ERROR_NONE
Gniazdo 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 do struktury gniazd UDP.
[in] aSockName
Wskaźnik do struktury adresów gniazd IPv6.
Zwracane wartości
OT_ERROR_NONE
Połączenie zakończone powodzeniem.
OT_ERROR_FAILED
Nie udało się połączyć gniazda UDP.

otUdpGetSockets

otUdpSocket * otUdpGetSockets(
  otInstance *aInstance
)

Pobiera nagłówek połączonej listy gniazd UDP.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do nagłówka listy połączonych połączeń 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 do 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źnik do ustawień wiadomości lub wartość NULL, która pozwala użyć ustawień domyślnych.
Zwroty
Wskaźnik do bufora wiadomości lub wartość NULL, jeśli nie są dostępne żadne 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 do struktury gniazd UDP.
[in] aCallback
Wskaźnik do funkcji wywołania zwrotnego aplikacji.
[in] aContext
Wskaźnik do kontekstu aplikacji.
Zwracane wartości
OT_ERROR_NONE
Gniazdo zostało otwarte.
OT_ERROR_FAILED
Nie udało się otworzyć gniazda.

otUdpRemoveReceiver

otError otUdpRemoveReceiver(
  otInstance *aInstance,
  otUdpReceiver *aUdpReceiver
)

Usuwa odbiornik UDP.

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

otUdpSend

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

Wyślij wiadomość UDP/IPv6.

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

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aSocket
Wskaźnik do struktury gniazd UDP.
[in] aMessage
Wskaźnik do bufora wiadomości.
[in] aMessageInfo
Wskaźnik struktury 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
Za mało dostępnego bufora, aby dodać nagłówki UDP i IPv6.

otUdpSendDatagram

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

Wysyła wiadomość UDP bez gniazda.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aMessage
Wskaźnik do wiadomości bez nagłówka UDP.
[in] aMessageInfo
Wskaźnik do informacji o wiadomości powiązanej z domeną aMessage.
Zwracane wartości
OT_ERROR_NONE
Wiadomość została dodana do kolejki w interfejsie wyjściowym.
OT_ERROR_NO_BUFS
Za mało dostępnego bufora, aby dodać nagłówki IPv6.
OT_ERROR_INVALID_ARGS
Podano nieprawidłowe argumenty.

Zasoby

Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, skorzystaj z sekcji Zasoby.