UDP
Este módulo inclui funções que controlam a comunicação UDP.
Resumo
Enumerações |
|
---|---|
otNetifIdentifier{
|
tipo enumerado Essa enumeração define os identificadores da interface de rede do OpenThread. |
Typedefs |
|
---|---|
otNetifIdentifier
|
typedefenum otNetifIdentifier
Essa enumeração define os identificadores da interface de rede do OpenThread. |
otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
typedefbool(*
Esse callback permite que o OpenThread forneça gerenciadores específicos para determinadas mensagens UDP. |
otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
typedefvoid(*
Esse callback permite que o OpenThread informe o aplicativo de uma mensagem UDP recebida. |
otUdpReceiver
|
typedefstruct otUdpReceiver
Essa estrutura representa um receptor UDP. |
otUdpSocket
|
typedefstruct otUdpSocket
Essa estrutura representa um soquete UDP. |
Functions |
|
---|---|
otUdpAddReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
|
Essa função adiciona um receptor UDP.
|
otUdpBind(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif)
|
Vincule um soquete UDP/IPv6.
|
otUdpClose(otInstance *aInstance, otUdpSocket *aSocket)
|
Feche um soquete UDP/IPv6.
|
otUdpConnect(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName)
|
Conecte um soquete UDP/IPv6.
|
otUdpGetSockets(otInstance *aInstance)
|
Essa função recebe o cabeçalho da lista de soquetes UDP vinculados.
|
otUdpIsOpen(otInstance *aInstance, const otUdpSocket *aSocket)
|
bool
Verifique se um soquete UDP está aberto.
|
otUdpNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
|
Aloque um novo buffer de mensagem para enviar uma mensagem UDP.
|
otUdpOpen(otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext)
|
Abra um soquete UDP/IPv6.
|
otUdpRemoveReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
|
Essa função remove um receptor UDP.
|
otUdpSend(otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
Envie uma mensagem UDP/IPv6.
|
otUdpSendDatagram(otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo)
|
Essa função envia uma mensagem UDP sem o soquete.
|
Estruturas |
|
---|---|
otUdpReceiver (em inglês) |
Essa estrutura representa um receptor UDP. |
otUdpSocket (link em inglês) |
Essa estrutura representa um soquete UDP. |
Enumerações
OtNetifIdentifier
otNetifIdentifier
Essa enumeração define os identificadores da interface de rede do OpenThread.
Propriedades | |
---|---|
OT_NETIF_BACKBONE
|
A interface do Backbone. |
OT_NETIF_THREAD
|
A interface do Thread. |
OT_NETIF_UNSPECIFIED
|
Interface de rede não especificada. |
Typedefs
OtNetifIdentifier
enum otNetifIdentifier otNetifIdentifier
Essa enumeração define os identificadores da interface de rede do OpenThread.
OtUdpHandler
bool(* otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)
Esse callback permite que o OpenThread forneça gerenciadores específicos para determinadas mensagens UDP.
Detalhes | |||||
---|---|---|---|---|---|
Valores de retorno |
|
OtUdpReceber
void(* otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Esse callback permite que o OpenThread informe o aplicativo de uma mensagem UDP recebida.
Functions
OtUdpAddReceiver
otError otUdpAddReceiver( otInstance *aInstance, otUdpReceiver *aUdpReceiver )
Essa função adiciona um receptor UDP.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtUdpBind
otError otUdpBind( otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif )
Vincule um soquete UDP/IPv6.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtUdpClose
otError otUdpClose( otInstance *aInstance, otUdpSocket *aSocket )
Feche um soquete UDP/IPv6.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtUdpConnect
otError otUdpConnect( otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName )
Conecte um soquete UDP/IPv6.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtUdpGetSockets
otUdpSocket * otUdpGetSockets( otInstance *aInstance )
Essa função recebe o cabeçalho da lista de soquetes UDP vinculados.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para o cabeçalho da lista de soquetes UDP.
|
OtUdpIsOpen
bool otUdpIsOpen( otInstance *aInstance, const otUdpSocket *aSocket )
Verifique se um soquete UDP está aberto.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Retorna |
Se o soquete UDP está aberto.
|
OtUdpNewMessage
otMessage * otUdpNewMessage( otInstance *aInstance, const otMessageSettings *aSettings )
Aloque um novo buffer de mensagem para enviar uma mensagem UDP.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Retorna |
Um ponteiro para o buffer da mensagem ou NULL se nenhum buffer de mensagem estiver disponível ou os parâmetros forem inválidos.
|
otMessageFree
OtUdpOpen
otError otUdpOpen( otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext )
Abra um soquete UDP/IPv6.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtUdpRemoveReceiver
otError otUdpRemoveReceiver( otInstance *aInstance, otUdpReceiver *aUdpReceiver )
Essa função remove um receptor UDP.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtUdpSend
otError otUdpSend( otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo )
Envie uma mensagem UDP/IPv6.
Se o valor de retorno for OT_ERROR_NONE, o OpenThread assumirá a propriedade do aMessage
e o autor da chamada não poderá mais fazer referência ao aMessage
. Se o valor de retorno não for OT_ERROR_NONE, o autor da chamada manterá a propriedade de aMessage
, incluindo a liberação de aMessage
se o buffer de mensagens não for mais necessário.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores de retorno |
|
OtUdpSendDatagram
otError otUdpSendDatagram( otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo )
Essa função envia uma mensagem UDP sem o soquete.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
Recursos
Os tópicos de referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para saber mais ou contribuir com nossa documentação, consulte Recursos.