SNTP

Ce module inclut des fonctions qui contrôlent la communication SNTP.

Résumé

Typedefs

otSntpQuery Typedef
struct otSntpQuery
Cette structure met en œuvre les paramètres de requête SNTP.
otSntpResponseHandler)(void *aContext, uint64_t aTime, otError aResult) Typedef
void(*
Ce pointeur de fonction est appelé lorsqu'une réponse SNTP est reçue.

Functions

otSntpClientQuery(otInstance *aInstance, const otSntpQuery *aQuery, otSntpResponseHandler aHandler, void *aContext)
Cette fonction envoie une requête SNTP.
otSntpClientSetUnixEra(otInstance *aInstance, uint32_t aUnixEra)
void
Cette fonction définit le nombre unix Unix.

Structure

otSntpQuery

Cette structure met en œuvre les paramètres de requête SNTP.

Typedefs

OTSntpQuery

struct otSntpQuery otSntpQuery

Cette structure met en œuvre les paramètres de requête SNTP.

otSntpResponseHandler

void(* otSntpResponseHandler)(void *aContext, uint64_t aTime, otError aResult)

Ce pointeur de fonction est appelé lorsqu'une réponse SNTP est reçue.

Détails
Paramètres
[in] aContext
Pointeur vers le contexte spécifique à l'application
[in] aTime
Indique l'heure au serveur à laquelle la réponse est laissée au client, au format UNIX.
[in] aResult
Résultat de la transaction SNTP.
Valeurs renvoyées
OT_ERROR_NONE
La réponse a bien été reçue, et le délai est fourni dans aTime.
OT_ERROR_ABORT
Une transaction SNTP a été annulée par la pile.
OT_ERROR_BUSY
Le paquet Kiss-o'-death a été reçu.
OT_ERROR_RESPONSE_TIMEOUT
Aucune réponse SNTP n'a été reçue au terme du délai imparti.
OT_ERROR_FAILED
Réponse reçue, mais contenant des données incorrectes.

Functions

OTSntpClientQuery

otError otSntpClientQuery(
  otInstance *aInstance,
  const otSntpQuery *aQuery,
  otSntpResponseHandler aHandler,
  void *aContext
)

Cette fonction envoie une requête SNTP.

Cette fonction n'est disponible que si la fonctionnalité OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE est activée.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aQuery
Pointeur permettant de spécifier les paramètres de requête SNTP.
[in] aHandler
Pointeur de fonction qui doit être appelé à la réception de la réponse ou en cas d'expiration du délai.
[in] aContext
Pointeur vers des informations de contexte arbitraires.

otSntpClientSetUnixEra.

void otSntpClientSetUnixEra(
  otInstance *aInstance,
  uint32_t aUnixEra
)

Cette fonction définit le nombre unix Unix.

La valeur par défaut de l'époque Unix est définie sur 0. Les époques suivantes commencent après l'année 2106.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aUnixEra
Nombre d'époques Unix.

Macros

OT_SNTP_DEFAULT_SERVER_IP

 OT_SNTP_DEFAULT_SERVER_IP "2001:4860:4806:8::"

Définit l'adresse de serveur SNTP par défaut : Google NTP Server.

OT_SNTP_DEFAULT_SERVER_PORT

 OT_SNTP_DEFAULT_SERVER_PORT 123

Définit le port de serveur SNTP par défaut.

Resources

Les sujets de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou pour contribuer à notre documentation, consultez la page Ressources.