ntpclient.h

Go to the documentation of this file.

/****************************************************************************
 *
 * Copyright 2016 Samsung Electronics All Rights Reserved.
 *
 * 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.
 *
 ****************************************************************************/
/****************************************************************************
 * apps/include/netutils/ntpclient.h
 *
 *   Copyright (C) 2014 Gregory Nutt. All rights reserved.
 *   Author: Gregory Nutt <gnutt@nuttx.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name NuttX nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/

#ifndef __APPS_INCLUDE_NETUTILS_NTPCLIENT_H
#define __APPS_INCLUDE_NETUTILS_NTPCLIENT_H 1

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <tinyara/config.h>
#include <netinet/in.h>

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
/* Configuration ************************************************************/

#define MAX_NTP_SERVER_NUM                                              5
#define MIN_NTP_POLL_INTERVAL_SECS 10               /* 10 seconds */
#define MAX_NTP_POLL_INTERVAL_SECS (24 * 60 * 60)   /* 24 hours */

/****************************************************************************
 * Public Types
 ****************************************************************************/

enum ntpc_daemon_e {
    NTP_NOT_RUNNING = 0,
    NTP_STARTED,
    NTP_RUNNING,
    NTP_STOP_REQUESTED,
    NTP_STOPPED
};

enum ntpc_link_status_e {
    NTP_LINK_NOT_SET = 0,
    NTP_LINK_DOWN,
    NTP_LINK_UP,
};

struct ntpc_server_conn_s {
    char *hostname;             /* host name */
    int port;                   /* port */
};

struct ntpc_server_s {
    struct ntpc_server_conn_s conn;
    in_addr_t ipaddr;           /* ip address */
    int link;                   /* link status */
};

/****************************************************************************
 * Public Data
 ****************************************************************************/

#ifdef __cplusplus
// *INDENT-OFF*
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
// *INDENT-ON*
#endif

/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/

int ntpc_start(struct ntpc_server_conn_s *server_list, uint32_t num_of_servers, uint32_t interval_secs, void *link_error_cb);

#ifndef CONFIG_DISABLE_SIGNALS
int ntpc_stop(void);
#endif

int ntpc_get_status(void);

int ntpc_get_link_status(void);

// @endcond

#undef EXTERN
#ifdef __cplusplus
// *INDENT-OFF*
}
// *INDENT-ON*
#endif

#endif                          /* __APPS_INCLUDE_NETUTILS_NTPCLIENT_H */
// end of NTPC group