1*dcdfe824SRobert Mustacchi.\" 2*dcdfe824SRobert Mustacchi.\" This file and its contents are supplied under the terms of the 3*dcdfe824SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0. 4*dcdfe824SRobert Mustacchi.\" You may only use this file in accordance with the terms of version 5*dcdfe824SRobert Mustacchi.\" 1.0 of the CDDL. 6*dcdfe824SRobert Mustacchi.\" 7*dcdfe824SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this 8*dcdfe824SRobert Mustacchi.\" source. A copy of the CDDL is also available via the Internet at 9*dcdfe824SRobert Mustacchi.\" http://www.illumos.org/license/CDDL. 10*dcdfe824SRobert Mustacchi.\" 11*dcdfe824SRobert Mustacchi.\" 12*dcdfe824SRobert Mustacchi.\" Copyright 2016 Joyent, Inc. 13*dcdfe824SRobert Mustacchi.\" 14*dcdfe824SRobert Mustacchi.Dd "Mar 25, 2016" 15*dcdfe824SRobert Mustacchi.Dt TIMESPEC_GET 3C 16*dcdfe824SRobert Mustacchi.Os 17*dcdfe824SRobert Mustacchi.Sh NAME 18*dcdfe824SRobert Mustacchi.Nm timespec_get 19*dcdfe824SRobert Mustacchi.Nd get time information 20*dcdfe824SRobert Mustacchi.Sh SYNOPSIS 21*dcdfe824SRobert Mustacchi.In time.h 22*dcdfe824SRobert Mustacchi.Ft int 23*dcdfe824SRobert Mustacchi.Fo timespec_get 24*dcdfe824SRobert Mustacchi.Fa "struct timespec *ts" 25*dcdfe824SRobert Mustacchi.Fa "int base" 26*dcdfe824SRobert Mustacchi.Fc 27*dcdfe824SRobert Mustacchi.Sh DESCRIPTION 28*dcdfe824SRobert MustacchiThe 29*dcdfe824SRobert Mustacchi.Fn timespec_get 30*dcdfe824SRobert Mustacchifunction provides access nanosecond resolution time. The 31*dcdfe824SRobert Mustacchimeaning and source of time is defined by the 32*dcdfe824SRobert Mustacchi.Fa base 33*dcdfe824SRobert Mustacchiargument. The following values are defined for 34*dcdfe824SRobert Mustacchi.Fa base : 35*dcdfe824SRobert Mustacchi.Bl -tag -width Ds 36*dcdfe824SRobert Mustacchi.It Sy TIME_UTC 37*dcdfe824SRobert MustacchiObtain the current time of day from the realtime clock on the system. It 38*dcdfe824SRobert Mustacchirepresents the amount of time in second and nanoseconds since the Epoch. 39*dcdfe824SRobert MustacchiThis is logically equivalent to calling 40*dcdfe824SRobert Mustacchi.Xr clock_gettime 3C 41*dcdfe824SRobert Mustacchiwith 42*dcdfe824SRobert Mustacchi.Sy CLOCK_REALTIME . 43*dcdfe824SRobert Mustacchi.El 44*dcdfe824SRobert Mustacchi.Pp 45*dcdfe824SRobert MustacchiFor the definition of the 46*dcdfe824SRobert Mustacchi.Sy timespec 47*dcdfe824SRobert Mustacchistructure, see 48*dcdfe824SRobert Mustacchi.Xr time.h 3HEAD . 49*dcdfe824SRobert Mustacchi.Sh RETURN VALUES 50*dcdfe824SRobert MustacchiUpon successful completion, the 51*dcdfe824SRobert Mustacchi.Fn timespec_get 52*dcdfe824SRobert Mustacchifunction returns the passed in value of 53*dcdfe824SRobert Mustacchi.Fa base . 54*dcdfe824SRobert MustacchiOtherwise, 55*dcdfe824SRobert Mustacchi.Sy 0 56*dcdfe824SRobert Mustacchiis returned to represent an error. 57*dcdfe824SRobert Mustacchi.Sh ERRORS 58*dcdfe824SRobert MustacchiUnlike other functions, the 59*dcdfe824SRobert Mustacchi.Fn timespec_get 60*dcdfe824SRobert Mustacchifunction is not defined to set 61*dcdfe824SRobert Mustacchi.Sy errno . 62*dcdfe824SRobert MustacchiHowever, the 63*dcdfe824SRobert Mustacchi.Fn timespec_get 64*dcdfe824SRobert Mustacchifunction will fail if: 65*dcdfe824SRobert Mustacchi.Bl -bullet -offset indent 66*dcdfe824SRobert Mustacchi.It 67*dcdfe824SRobert MustacchiThe value of 68*dcdfe824SRobert Mustacchi.Fa base 69*dcdfe824SRobert Mustacchidoes not refer to a known time specification. 70*dcdfe824SRobert Mustacchi.It 71*dcdfe824SRobert MustacchiThere was an error obtaining the time for 72*dcdfe824SRobert Mustacchi.Fa base . 73*dcdfe824SRobert Mustacchi.El 74*dcdfe824SRobert Mustacchi.Sh INTERFACE STABILITY 75*dcdfe824SRobert Mustacchi.Sy Standard 76*dcdfe824SRobert Mustacchi.Sh MT-LEVEL 77*dcdfe824SRobert Mustacchi.Sy MT-Safe 78*dcdfe824SRobert Mustacchi.Sh SEE ALSO 79*dcdfe824SRobert Mustacchi.Xr clock_gettime 3C , 80*dcdfe824SRobert Mustacchi.Xr time.h 3HEAD , 81*dcdfe824SRobert Mustacchi.Xr attributes 5 82