lib/libc/sys/ntp_gettime.2

   1 .\"
   2 .\" Copyright (c) 2003 Tom Rhodes
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/lib/libc/sys/ntp_gettime.2,v 1.1.2.1 2003/04/22 17:31:18 trhodes Exp $
  27 .\"
  28 .Dd April 1, 2003
  29 .Dt NTP_GETTIME 2
  30 .Os
  31 .Sh NAME
  32 .Nm ntp_gettime
  33 .Nd NTP user application interface
  34 .Sh SYNOPSIS
  35 .In sys/timex.h
  36 .Ft int
  37 .Fn ntp_gettime "struct ntptimeval *ntv"
  38 .Sh DESCRIPTION
  39 The time returned by
  40 .Fn ntp_gettime
  41 is in a
  42 .Vt timespec
  43 structure, but may be in either microsecond
  44 (seconds and microseconds) or nanosecond (seconds and nanoseconds) format.
  45 The particular format in use is determined by the
  46 .Dv STA_NANO
  47 bit of the status
  48 word returned by the
  49 .Fn ntp_adjtime
  50 system call.
  51 .Fn ntp_gettime
  52 has as argument a pointer to the
  53 .Vt ntptimeval
  54 structure with the following members:
  55 .Bd -literal
  56 struct ntptimeval {
  57         struct timespec time;   /* current time (ns) (ro) */
  58         long maxerror;          /* maximum error (us) (ro) */
  59         long esterror;          /* estimated error (us) (ro) */
  60         long tai;               /* TAI offset */
  61         int time_state;         /* time status */
  62 };
  63 .Ed
  64 .Pp
  65 These are understood as:
  66 .Bl -tag -width ".Va time_state"
  67 .It Va time
  68 Current time (read-only).
  69 .It Va maxerror
  70 Maximum error in microseconds (read-only).
  71 .It Va esterror
  72 Estimated error in microseconds (read-only).
  73 .It Va tai
  74 Temps Atomique International (French for International Atomic Time),
  75 measures real time.
  76 Used for acute time measurements.
  77 .It Va time_state
  78 Current time status.
  79 .El
  80 .Sh RETURN VALUES
  81 .Rv -std ntp_gettime
  82 .Pp
  83 Possible states of the clock are:
  84 .Pp
  85 .Bl -tag -compact -width ".Dv TIME_ERROR"
  86 .It Dv TIME_OK
  87 Everything okay, no leap second warning.
  88 .It Dv TIME_INS
  89 Insert leap second warning.
  90 .It Dv TIME_DEL
  91 Delete leap second warning.
  92 .It Dv TIME_OOP
  93 Leap second in progress.
  94 .It Dv TIME_WAIT
  95 Leap second has occurred.
  96 .It Dv TIME_ERROR
  97 Clock not synchronized.
  98 .El
  99 .Sh SEE ALSO
 100 .Xr ntp_adjtime 2 ,
 101 .Xr ntpd 8
 102 .Sh AUTHORS
 103 This manual page was written by
 104 .An Tom Rhodes Aq trhodes@FreeBSD.org .