UDP Ce module comprend des fonctions qui contrôlent la communication UDP.
Sommaire Typedefs otUdpHandler )(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef bool(*
Ce rappel permet à OpenThread de fournir des gestionnaires spécifiques pour certains messages UDP.
otUdpReceive )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef void(*
Ce rappel permet à OpenThread d'informer l'application d'un message UDP reçu.
otUdpReceiver typedef Cette structure représente un récepteur UDP.
otUdpSocket typedef Cette structure représente un socket UDP.
Les fonctions otUdpAddReceiver ( otInstance *aInstance, otUdpReceiver *aUdpReceiver) Cette fonction ajoute un récepteur UDP.
otUdpBind ( otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName) Liez un socket UDP / IPv6.
otUdpClose ( otInstance *aInstance, otUdpSocket *aSocket) Fermez un socket UDP / IPv6.
otUdpConnect ( otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName) Connectez une prise UDP / IPv6.
otUdpGetSockets ( otInstance *aInstance) Cette fonction obtient la tête de la liste chaînée des sockets UDP.
otUdpNewMessage ( otInstance *aInstance, const otMessageSettings *aSettings) Allouez un nouveau tampon de messages pour l'envoi d'un message UDP.
otUdpOpen ( otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext) Ouvrez un socket UDP / IPv6.
otUdpRemoveReceiver ( otInstance *aInstance, otUdpReceiver *aUdpReceiver) Cette fonction supprime un récepteur UDP.
otUdpSend ( otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo) Envoyez un message UDP / IPv6.
otUdpSendDatagram ( otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo) Cette fonction envoie un message UDP sans socket.
Structs otUdpReceiver Cette structure représente un récepteur UDP.
otUdpSocket Cette structure représente un socket UDP.
Typedefs otUdpHandler bool(* otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo) Ce rappel permet à OpenThread de fournir des gestionnaires spécifiques pour certains messages UDP.
Détails Valeurs de retour true Le message est traité par ce récepteur et ne doit plus être traité.
false Le message n'est pas traité par ce récepteur.
otUdpReceive void(* otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) Ce rappel permet à OpenThread d'informer l'application d'un message UDP reçu.
otUdpReceiver struct otUdpReceiver otUdpReceiver Cette structure représente un récepteur UDP.
otUdpSocket struct otUdpSocket otUdpSocket Cette structure représente un socket UDP.
Les fonctions otUdpAddReceiver otError otUdpAddReceiver(
otInstance *aInstance,
otUdpReceiver *aUdpReceiver
) Cette fonction ajoute un récepteur UDP.
Détails Paramètres [in] aInstance Un pointeur vers une instance d'OpenThread.
[in] aUdpReceiver Un pointeur vers le récepteur UDP.
Valeurs de retour OT_ERROR_NONE Le récepteur est ajouté avec succès.
OT_ERROR_ALREADY Le récepteur UDP a déjà été ajouté.
otUdpBind otError otUdpBind(
otInstance *aInstance,
otUdpSocket *aSocket,
const otSockAddr *aSockName
) Liez un socket UDP / IPv6.
Détails Paramètres [in] aInstance Un pointeur vers une instance d'OpenThread.
[in] aSocket Un pointeur vers une structure de socket UDP.
[in] aSockName Un pointeur vers une structure d'adresse de socket IPv6.
Valeurs de retour OT_ERROR_NONE L'opération de liaison a réussi.
OT_ERROR_FAILED Échec de la liaison du socket UDP.
otUdpClose otError otUdpClose(
otInstance *aInstance,
otUdpSocket *aSocket
) Fermez un socket UDP / IPv6.
Détails Paramètres [in] aInstance Un pointeur vers une instance d'OpenThread.
[in] aSocket Un pointeur vers une structure de socket UDP.
Valeurs de retour OT_ERROR_NONE Fermé avec succès la prise.
OT_ERROR_FAILED Échec de la fermeture du socket UDP.
otUdpConnect otError otUdpConnect(
otInstance *aInstance,
otUdpSocket *aSocket,
const otSockAddr *aSockName
) Connectez une prise UDP / IPv6.
Détails Paramètres [in] aInstance Un pointeur vers une instance d'OpenThread.
[in] aSocket Un pointeur vers une structure de socket UDP.
[in] aSockName Un pointeur vers une structure d'adresse de socket IPv6.
Valeurs de retour OT_ERROR_NONE L'opération de connexion a réussi.
OT_ERROR_FAILED Échec de la connexion du socket UDP.
otUdpGetSockets otUdpSocket * otUdpGetSockets(
otInstance *aInstance
) Cette fonction obtient la tête de la liste chaînée des sockets UDP.
Détails Paramètres [in] aInstance Un pointeur vers une instance d'OpenThread.
Retour Un pointeur vers la tête de la liste liée du socket UDP.
otUdpNewMessage otMessage * otUdpNewMessage(
otInstance *aInstance,
const otMessageSettings *aSettings
) Allouez un nouveau tampon de messages pour l'envoi d'un message UDP.
Remarque: Si aSettings est 'NULL', la sécurité de la couche liaison est activée et la priorité du message est définie sur OT_MESSAGE_PRIORITY_NORMAL par défaut.
Détails Paramètres [in] aInstance Un pointeur vers une instance d'OpenThread.
[in] aSettings Un pointeur vers les paramètres du message ou NULL pour utiliser les paramètres par défaut.
Retour Un pointeur vers le tampon de message ou NULL si aucun tampon de message n'est disponible ou si les paramètres ne sont pas valides.
Voir également: otMessageFree otUdpOpen otError otUdpOpen(
otInstance *aInstance,
otUdpSocket *aSocket,
otUdpReceive aCallback,
void *aContext
) Ouvrez un socket UDP / IPv6.
Détails Paramètres [in] aInstance Un pointeur vers une instance d'OpenThread.
[in] aSocket Un pointeur vers une structure de socket UDP.
[in] aCallback Un pointeur vers la fonction de rappel de l'application.
[in] aContext Un pointeur vers le contexte spécifique à l'application.
Valeurs de retour OT_ERROR_NONE Ouverture réussie du socket.
OT_ERROR_FAILED Impossible d'ouvrir le socket.
otUdpRemoveReceiver otError otUdpRemoveReceiver(
otInstance *aInstance,
otUdpReceiver *aUdpReceiver
) Cette fonction supprime un récepteur UDP.
Détails Paramètres [in] aInstance Un pointeur vers une instance d'OpenThread.
[in] aUdpReceiver Un pointeur vers le récepteur UDP.
Valeurs de retour OT_ERROR_NONE Le récepteur a été supprimé avec succès.
OT_ERROR_NOT_FOUND Le récepteur UDP n'a pas été ajouté.
otUdpSend otError otUdpSend(
otInstance *aInstance,
otUdpSocket *aSocket,
otMessage *aMessage,
const otMessageInfo *aMessageInfo
) Envoyez un message UDP / IPv6.
Si la valeur de retour est OT_ERROR_NONE, OpenThread prend possession de aMessage et l'appelant ne doit plus faire référence à aMessage . Si la valeur de retour n'est pas OT_ERROR_NONE, l'appelant conserve la propriété d'un aMessage , y compris la libération d'un aMessage si le tampon de messages n'est plus nécessaire.
Détails Paramètres [in] aInstance Un pointeur vers une instance d'OpenThread.
[in] aSocket Un pointeur vers une structure de socket UDP.
[in] aMessage Un pointeur vers un tampon de messages.
[in] aMessageInfo Un pointeur vers une structure d'informations de message.
Détails Valeurs de retour OT_ERROR_NONE L'envoi du message est planifié avec succès.
OT_ERROR_INVALID_ARGS Des arguments non valides sont donnés.
OT_ERROR_NO_BUFS Mémoire tampon disponible insuffisante pour ajouter les en-têtes UDP et IPv6.
otUdpSendDatagram otError otUdpSendDatagram(
otInstance *aInstance,
otMessage *aMessage,
otMessageInfo *aMessageInfo
) Cette fonction envoie un message UDP sans socket.
Détails Paramètres [in] aInstance Un pointeur vers une instance d'OpenThread.
[in] aMessage Un pointeur vers un message sans en-tête UDP.
[in] aMessageInfo Un pointeur sur une information de message associé à aMessage .
Valeurs de retour OT_ERROR_NONE Mise en file d'attente réussie du message dans une interface de sortie.
OT_ERROR_NO_BUFS Mémoire tampon disponible insuffisante pour ajouter les en-têtes IPv6.
