Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_DATE_TIME_BUF_LEN 20 /* includes trailing '\0' */ |
#define | OPEN_TIMEZONE_BUF_LEN 15 /* includes trailing '\0' */ |
Enumerations | |
enum | OPEN_TIME_CLOCK_SRC_t { OPEN_CLOCK_SRC_NONE = 0, OPEN_CLOCK_SRC_SNTP = 1 } |
Functions | |
open_error_t | openapiClockGet (openapiClientHandle_t *client_handle, open_buffdesc *bufd, OPEN_TIME_CLOCK_SRC_t *clockSrc) |
Get the date and time from the system clock. More... | |
open_error_t | openapiClockSet (openapiClientHandle_t *client_handle, open_buffdesc *bufd) |
Set the system clock date and time. More... | |
open_error_t | openapiTimeZoneGet (openapiClientHandle_t *client_handle, open_buffdesc *bufd) |
Get the time zone from the system clock. More... | |
open_error_t | openapiTimeZoneSet (openapiClientHandle_t *client_handle, open_buffdesc *bufd) |
Set the system clock time zone. More... | |
open_error_t openapiClockGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bufd, | ||
OPEN_TIME_CLOCK_SRC_t * | clockSrc | ||
) |
Get the date and time from the system clock.
[in] | client_handle | client handle from registration API |
[out] | bufd | buffer descriptor containing date and time Buffer length value OPEN_DATE_TIME_BUF_LEN |
[out] | clockSrc | indicates clock source Possible values OPEN_TIME_CLOCK_SRC_t |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | SNTP internal error. |
OpEN API Version: 1.14
open_error_t openapiClockSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bufd | ||
) |
Set the system clock date and time.
[in] | client_handle | client handle from registration API |
[in] | bufd | buffer descriptor containing date and time Buffer length value OPEN_DATE_TIME_BUF_LEN |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | SNTP is not supported on the platform or an SNTP internal error. |
OpEN API Version: 1.14
open_error_t openapiTimeZoneGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bufd | ||
) |
Get the time zone from the system clock.
[in] | client_handle | client handle from registration API |
[out] | bufd | buffer descriptor containing time zone Buffer length value OPEN_TIMEZONE_BUF_LEN |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
open_error_t openapiTimeZoneSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bufd | ||
) |
Set the system clock time zone.
[in] | client_handle | client handle from registration API |
[in] | bufd | buffer descriptor containing time zone Buffer length value OPEN_TIMEZONE_BUF_LEN |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14