openapi_time.h

Go to the documentation of this file.

/*********************************************************************
*
*  Copyright 2016-2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename  openapi_time.h
*
* @purpose   Date & Time Configuration and Status 
*
* @component OpEN
*
* @create    09/29/2016
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_TIME_H_INCLUDED
#define OPENAPI_TIME_H_INCLUDED

#include "openapi_common.h"

typedef enum
{
  OPEN_CLOCK_SRC_NONE  = 0, 
  OPEN_CLOCK_SRC_SNTP  = 1, 
  OPEN_CLOCK_SRC_NTP  = 2   
} OPEN_TIME_CLOCK_SRC_t;

#define OPEN_TIMEZONE_BUF_LEN       15 /* includes trailing '\0' */

/*****************************************************************/
open_error_t openapiClockGet(openapiClientHandle_t *client_handle,
                             open_buffdesc *bufd,
                             OPEN_TIME_CLOCK_SRC_t *clockSrc);

/*****************************************************************/
open_error_t openapiClockSet(openapiClientHandle_t *client_handle,
                             open_buffdesc *bufd);

/*****************************************************************/
open_error_t openapiTimeZoneGet(openapiClientHandle_t *client_handle,
                                open_buffdesc *bufd);

/*****************************************************************/
open_error_t openapiTimeZoneSet(openapiClientHandle_t *client_handle,
                                open_buffdesc *bufd);

#endif /* OPENAPI_TIME_H_INCLUDED */