Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.

UDP

Este módulo incluye funciones que controlan la comunicación UDP.

Resumen

Enumeraciones
otNetifIdentifier{
  OT_NETIF_UNSPECIFIED = 0,
  OT_NETIF_THREAD,
  OT_NETIF_BACKBONE
} 		enum
Esta enumeración define los identificadores de la interfaz de red de OpenThread.

Typedefs
otNetifIdentifier typedef
Esta enumeración define los identificadores de la interfaz de red de OpenThread.
otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
bool(*
Esta devolución de llamada permite que OpenThread proporcione controladores específicos para ciertos mensajes UDP.
otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
Esta devolución de llamada permite que OpenThread informe a la aplicación un mensaje UDP recibido.
otUdpReceiver typedef
struct otUdpReceiver
Esta estructura representa un receptor UDP.
otUdpSocket typedef
struct otUdpSocket
Esta estructura representa un socket UDP.

Functions
otUdpAddReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
Esta función agrega un receptor UDP.
otUdpBind(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif)
Vincula un socket UDP/IPv6.
otUdpClose(otInstance *aInstance, otUdpSocket *aSocket)
Cierra un socket UDP/IPv6.
otUdpConnect(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName)
Conecta un socket UDP/IPv6.
otUdpGetSockets(otInstance *aInstance)
Esta función obtiene el encabezado de la lista vinculada de sockets UDP.
otUdpIsOpen(otInstance *aInstance, const otUdpSocket *aSocket)
bool
Verifica si hay un socket UDP abierto.
otUdpNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
Asigna un nuevo búfer de mensajes para enviar un mensaje UDP.
otUdpOpen(otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext)
Abre un socket UDP/IPv6.
otUdpRemoveReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
Esta función quita un receptor UDP.
otUdpSend(otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Envía un mensaje UDP o IPv6.
otUdpSendDatagram(otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo)
Esta función envía un mensaje UDP sin socket.

Structs
otUdpReceiver

Esta estructura representa un receptor UDP.

otUdpsocket

Esta estructura representa un socket UDP.

Enumeraciones

otNetifIdentifier

 otNetifIdentifier

Esta enumeración define los identificadores de la interfaz de red de OpenThread.

Properties
OT_NETIF_BACKBONE

La interfaz de Backbone.

OT_NETIF_THREAD

La interfaz de Thread

OT_NETIF_UNSPECIFIED

Interfaz de red no especificada.

Typedefs

otNetifIdentifier

enum otNetifIdentifier otNetifIdentifier

Esta enumeración define los identificadores de la interfaz de red de OpenThread.

otUdpHandler

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

Esta devolución de llamada permite que OpenThread proporcione controladores específicos para ciertos mensajes UDP.

Detalles
Valores que se muestran
true
Este mensaje lo maneja el receptor y no debe procesarse más.
false
Este receptor no maneja el mensaje.

otUdpReceive

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

Esta devolución de llamada permite que OpenThread informe a la aplicación un mensaje UDP recibido.

otUdpReceiver

struct otUdpReceiver otUdpReceiver

Esta estructura representa un receptor UDP.

OtUdpsocket

struct otUdpSocket otUdpSocket

Esta estructura representa un socket UDP.

Functions

otUdpAddReceiver

otError otUdpAddReceiver(
  otInstance *aInstance,
  otUdpReceiver *aUdpReceiver
)

Esta función agrega un receptor UDP.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aUdpReceiver
Un puntero para el receptor UDP.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente el receptor.
OT_ERROR_ALREADY
Ya se agregó el receptor UDP.

otUdpBind

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

Vincula un socket UDP/IPv6.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aSocket
Un puntero para una estructura de socket UDP.
[in] aSockName
Un puntero para una estructura de dirección de socket IPv6.
[in] aNetif
La interfaz de red que se vinculará.
Valores que se muestran
OT_ERROR_NONE
Se completó correctamente la operación de vinculación.
OT_ERROR_FAILED
No se pudo vincular el socket UDP.

otUdpCerrar

otError otUdpClose(
  otInstance *aInstance,
  otUdpSocket *aSocket
)

Cierra un socket UDP/IPv6.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aSocket
Un puntero para una estructura de socket UDP.
Valores que se muestran
OT_ERROR_NONE
Se cerró correctamente el socket.
OT_ERROR_FAILED
No se pudo cerrar el socket UDP.

otUdpConnect

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

Conecta un socket UDP/IPv6.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aSocket
Un puntero para una estructura de socket UDP.
[in] aSockName
Un puntero para una estructura de dirección de socket IPv6.
Valores que se muestran
OT_ERROR_NONE
Se completó correctamente la operación de conexión.
OT_ERROR_FAILED
No se pudo conectar el socket UDP.

otUdpGetSockets

otUdpSocket * otUdpGetSockets(
  otInstance *aInstance
)

Esta función obtiene el encabezado de la lista vinculada de sockets UDP.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero al encabezado de la lista de sockets de UDP.

OtUdpIsOpen

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

Verifica si hay un socket UDP abierto.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aSocket
Un puntero para una estructura de socket UDP.
Qué muestra
Indica si el socket UDP está abierto.

otUdpNewMessage

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

Asigna un nuevo búfer de mensajes para enviar un mensaje UDP.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aSettings
Un puntero para la configuración del mensaje o NULL para usar la configuración predeterminada
Qué muestra
Un puntero al búfer de mensajes o NULL si no hay búferes de mensaje disponibles o los parámetros no son válidos.
Consulta también:
otMessageFree

otUdpOpen

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

Abre un socket UDP/IPv6.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aSocket
Un puntero para una estructura de socket UDP.
[in] aCallback
Un puntero para la función de devolución de llamada de la aplicación.
[in] aContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Se abrió correctamente el socket.
OT_ERROR_FAILED
No se pudo abrir el socket.

otUdpRemoveReceiver

otError otUdpRemoveReceiver(
  otInstance *aInstance,
  otUdpReceiver *aUdpReceiver
)

Esta función quita un receptor UDP.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aUdpReceiver
Un puntero para el receptor UDP.
Valores que se muestran
OT_ERROR_NONE
Se quitó correctamente el receptor.
OT_ERROR_NOT_FOUND
No se agregó el receptor UDP.

otUdpSend

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

Envía un mensaje UDP o IPv6.

Si el valor que se muestra es OT_ERROR_NONE, OpenThread toma la propiedad de aMessage, y el emisor ya no debería hacer referencia a aMessage. Si el valor que se muestra no es OT_ERROR_NONE, el emisor retiene la propiedad de aMessage, lo que incluye la liberación de aMessage si ya no se necesita el búfer de mensajes.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aSocket
Un puntero para una estructura de socket UDP.
[in] aMessage
Un puntero para un búfer de mensajes.
[in] aMessageInfo
Un puntero para una estructura de información de mensajes.

Detalles
Valores que se muestran
OT_ERROR_NONE
Se programó correctamente el envío del mensaje.
OT_ERROR_INVALID_ARGS
Se proporcionaron argumentos no válidos.
OT_ERROR_NO_BUFS
El búfer disponible no es suficiente para agregar los encabezados UDP y IPv6.

otUdpSendDatagram

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

Esta función envía un mensaje UDP sin socket.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMessage
Un puntero para un mensaje sin encabezado UDP.
[in] aMessageInfo
Un puntero para una información de mensaje asociada con aMessage.
Valores que se muestran
OT_ERROR_NONE
El mensaje se puso en cola correctamente en una interfaz de salida.
OT_ERROR_NO_BUFS
El búfer disponible no es suficiente para agregar los encabezados IPv6.

Recursos

Los temas de referencia de la API de OpenThread se originan en el código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta Recursos.