timespec_get.3 (7e299411ac91383d8a28de9fadd2b4ed8a148fff) timespec_get.3 (3d19db5dfb957aa57cce016c0df7711fc5269e44)
1.\" $NetBSD: timespec_get.3,v 1.2 2016/10/04 10:46:40 wiz Exp $
2.\"
3.\" Copyright (c) 2016 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Kamil Rytarowski.
8.\"

--- 15 unchanged lines hidden (view full) ---

24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\" $FreeBSD$
31.\"
1.\" $NetBSD: timespec_get.3,v 1.2 2016/10/04 10:46:40 wiz Exp $
2.\"
3.\" Copyright (c) 2016 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Kamil Rytarowski.
8.\"

--- 15 unchanged lines hidden (view full) ---

24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\" $FreeBSD$
31.\"
32.Dd October 4, 2016
32.Dd August 10, 2018
33.Dt TIMESPEC_GET 3
34.Os
35.Sh NAME
36.Nm timespec_get
37.Nd get current calendar time
38.Sh LIBRARY
39.Lb libc
40.Sh SYNOPSIS
41.In time.h
33.Dt TIMESPEC_GET 3
34.Os
35.Sh NAME
36.Nm timespec_get
37.Nd get current calendar time
38.Sh LIBRARY
39.Lb libc
40.Sh SYNOPSIS
41.In time.h
42.Vt #define TIME_UTC 1
43.Ft int
44.Fn timespec_get "struct timespec *ts" "int base"
45.Sh DESCRIPTION
46The
47.Nm
48function sets the interval pointed to by
49.Fa ts
50to hold the current calendar time based on the specified time base in
51.Fa base .
52.Pp
42.Ft int
43.Fn timespec_get "struct timespec *ts" "int base"
44.Sh DESCRIPTION
45The
46.Nm
47function sets the interval pointed to by
48.Fa ts
49to hold the current calendar time based on the specified time base in
50.Fa base .
51.Pp
53Currently the only supported valid base is
54.Dv TIME_UTC .
55It returns time elapsed since epoch.
52The base
53.Dv TIME_UTC
54returns the time since the epoch.
55This time is expressed in seconds and nanoseconds since midnight (0 hour), January 1, 1970.
56In
57.Fx ,
58this corresponds to
59.Dv CLOCK_REALTIME .
56.Sh RETURN VALUES
57The
58.Nm
59function returns the passed value of
60.Fa base
61if successful, otherwise
62.Dv 0
63on failure.
60.Sh RETURN VALUES
61The
62.Nm
63function returns the passed value of
64.Fa base
65if successful, otherwise
66.Dv 0
67on failure.
64.\" .Sh ERRORS
65.Sh SEE ALSO
68.Sh SEE ALSO
66.Xr clock_gettime 2
69.Xr gettimeofday 2 ,
70.Xr clock_gettime 2 ,
71.Xr time 3
67.Sh STANDARDS
68The
69.Nm
72.Sh STANDARDS
73The
74.Nm
70function conforms to
75function with a
76.Fa base
77of
78.Dv TIME_UTC
79conforms to
71.St -isoC-2011 .
72.Sh HISTORY
73This interface first appeared in
80.St -isoC-2011 .
81.Sh HISTORY
82This interface first appeared in
74.Nx 8 .
83.Fx 12 .
75.Sh AUTHORS
76.An Kamil Rytarowski Aq Mt kamil@NetBSD.org
84.Sh AUTHORS
85.An Kamil Rytarowski Aq Mt kamil@NetBSD.org
86.An Warner Losh Aq Mt imp@FreeBSD.org