Add more comment for mbedtls_ms_time
Signed-off-by: Jerry Yu <jerry.h.yu@arm.com>
This commit is contained in:
parent
947fd3d6ea
commit
b1d3015e27
1 changed files with 7 additions and 2 deletions
|
@ -46,12 +46,17 @@ typedef signed long long mbedtls_ms_time_t;
|
||||||
#endif /* MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO */
|
#endif /* MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Get time in milliseconds.
|
* \brief Get time in milliseconds.
|
||||||
*
|
*
|
||||||
* \return Current time in milliseconds
|
* \return Current time in milliseconds which is monotonically increasing.
|
||||||
*
|
*
|
||||||
* \note If MBEDTLS_PLATFORM_MS_TIME_ALT defined, users can provide their own
|
* \note If MBEDTLS_PLATFORM_MS_TIME_ALT defined, users can provide their own
|
||||||
* implementation.
|
* implementation.
|
||||||
|
*
|
||||||
|
* \warning This function is used for time difference only. The start time is
|
||||||
|
* not defined. A well defined time function is not required in
|
||||||
|
* TLS negotiation.
|
||||||
|
*
|
||||||
*/
|
*/
|
||||||
mbedtls_ms_time_t mbedtls_ms_time(void);
|
mbedtls_ms_time_t mbedtls_ms_time(void);
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue