SNTP
This module includes functions that control SNTP communication.
Summary
Typedefs |
|
---|---|
otSntpQuery
|
typedefstruct otSntpQuery
This structure implements SNTP Query parameters. |
otSntpResponseHandler)(void *aContext, uint64_t aTime, otError aResult)
|
typedefvoid(*
This function pointer is called when a SNTP response is received. |
Functions |
|
---|---|
otSntpClientQuery(otInstance *aInstance, const otSntpQuery *aQuery, otSntpResponseHandler aHandler, void *aContext)
|
This function sends a SNTP query.
|
otSntpClientSetUnixEra(otInstance *aInstance, uint32_t aUnixEra)
|
void
This function sets the unix era number.
|
Structs |
|
---|---|
otSntpQuery |
This structure implements SNTP Query parameters. |
Typedefs
otSntpResponseHandler
void(* otSntpResponseHandler)(void *aContext, uint64_t aTime, otError aResult)
This function pointer is called when a SNTP response is received.
Details | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||||
Return Values |
|
Functions
otSntpClientQuery
otError otSntpClientQuery( otInstance *aInstance, const otSntpQuery *aQuery, otSntpResponseHandler aHandler, void *aContext )
This function sends a SNTP query.
This function is available only if feature OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE
is enabled.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
otSntpClientSetUnixEra
void otSntpClientSetUnixEra( otInstance *aInstance, uint32_t aUnixEra )
This function sets the unix era number.
The default value of unix era is set to 0. The subsequent eras start after year 2106.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
Macros
OT_SNTP_DEFAULT_SERVER_IP
OT_SNTP_DEFAULT_SERVER_IP "2001:4860:4806:8::"
Defines default SNTP Server address - Google NTP Server.
OT_SNTP_DEFAULT_SERVER_PORT
OT_SNTP_DEFAULT_SERVER_PORT 123
Defines default SNTP Server port.