clock_settime()
Set a clock
Synopsis:
#include <time.h>
int clock_settime( clockid_t id,
const struct timespec * tp );
Arguments:
- id
- One of the following:
- CLOCK_REALTIME, the ID of the clock that maintains the system time
- CLOCK_PROCESS_CPUTIME_ID, the ID that refers to the CPU time of the calling process
- CLOCK_PROCESS_THREAD_ID, the ID that refers to the CPU time of the calling thread
- (QNX OS 7.X or later) the ID of a process or thread CPU-time clock that's returned by ClockId(), clock_getcpuclockid(), or pthread_getcpuclockid()
- tp
- A pointer to a
timespec
structure containing at least the following members:
- tv_sec — the number of seconds since 1970.
- tv_nsec — the number of nanoseconds in the current second. This value increases by some multiple of nanoseconds, based on the system clock's resolution.
Library:
libc
Use the -l c option to qcc to link against this library. This library is usually included automatically.
Description:
The clock_settime() function sets the clock specified by id to the time specified in the buffer pointed to by tp.
- Be careful if you set the date during the period that a time zone is switching from daylight saving time (DST) to standard time. When a time zone changes to standard time, the local time goes back one hour (for example, 2:00 a.m. becomes 1:00 a.m.). The local time during this hour is ambiguous (e.g., 1:14 a.m. occurs twice in the morning that the time zone switches to standard time). To avoid problems, use UTC time to set the date during this period.
- You can't set the time when the id is CLOCK_MONOTONIC.
- In order to set the clock, your process must have the PROCMGR_AID_CLOCKSET ability enabled, including when changing the CPU-time clock for another process or a thread in another process. For more information, see procmgr_ability().
- Changing the CPU-time clock for procnto or procnto threads
(i.e.,
ClockId(1,*)) is not permitted. Changing the CPU-time clock time doesn't affect user and system running time values reported by getrusage(), waitid(), and devctl() with the DCMD_PROC_INFO or DCMD_PROC_TIDSTATUS commands. The clock_settime() function also doesn't affect RLIMIT_CPU.
Calling clock_settime() with a clock ID of CLOCK_PROCESS_CPUTIME_ID will affect clock_gettime() when it's given this same clock ID, but will not affect getrusage() when it's given RUSAGE_SELF for the who argument.
If you change the time for CLOCK_REALTIME, the change occurs immediately, and the expiry time for some timers might end up in the past. In this case, the timers will expire on the next clock tick. If you need the affected timers to expire before the next clock tick, then before changing the time, set a high-resolution timer to expire just after the new time; after you change the time, the high-resolution timer will expire and so will all the affected timers.
Returns:
- 0
- Success
- -1
- An error occurred (errno is set).
Errors:
- EINVAL
- One of the following occurred:
- The id is invalid. You can't set the time for CLOCK_MONOTONIC.
- The number of nanoseconds specified by the tv_nsec member is less than zero or greater than or equal to 1000 million.
- The tv_sec member is -1 (which could happen if you set it to the result from mktime() without checking to see if the call succeeded).
- EPERM
- One of the following occurred:
- The calling process doesn't have the required permission; see procmgr_ability().
- You tried to set the time for a process or thread CPU-time clock.
Examples:
/* This program sets the clock forward 1 day. */
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <time.h>
int main( void )
{
struct timespec stime;
if( clock_gettime( CLOCK_REALTIME, &stime) == -1 ) {
perror( "getclock" );
return EXIT_FAILURE;
}
stime.tv_sec += (60*60)*24L; /* Add one day */
stime.tv_nsec = 0;
if( clock_settime( CLOCK_REALTIME, &stime) == -1 ) {
perror( "setclock" );
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
Classification:
| Safety: | |
|---|---|
| Cancellation point | No |
| Signal handler | Yes |
| Thread | Yes |