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