ntp_client.h 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. /*
  2. * File : ntp.h
  3. * This file is part of RT-Thread RTOS
  4. * COPYRIGHT (C) 2006 - 2018, RT-Thread Development Team
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License along
  17. * with this program; if not, write to the Free Software Foundation, Inc.,
  18. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19. *
  20. * Change Logs:
  21. * Date Author Notes
  22. * 2018-02-10 armink the first version
  23. */
  24. #ifndef _NTP_CLIENT_H_
  25. #define _NTP_CLIENT_H_
  26. #include <time.h>
  27. /**
  28. * Get the UTC time from NTP server
  29. *
  30. * @param host_name NTP server host name, NULL: will using default host name
  31. *
  32. * @note this function is not reentrant
  33. *
  34. * @return >0: success, current UTC time
  35. * =0: get failed
  36. */
  37. time_t wayz_get_time_by_ntp(const char *host_name);
  38. #endif /* _NTP_CLIENT_H_ */