You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
116 lines
4.1 KiB
116 lines
4.1 KiB
'\" t
|
|
.\" Title: zclock
|
|
.\" Author: [see the "AUTHORS" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
|
.\" Date: 12/31/2016
|
|
.\" Manual: CZMQ Manual
|
|
.\" Source: CZMQ 4.0.2
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ZCLOCK" "3" "12/31/2016" "CZMQ 4\&.0\&.2" "CZMQ Manual"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
zclock \- millisecond clocks and delays
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
// This is a stable class, and may not change except for emergencies\&. It
|
|
// is provided in stable builds\&.
|
|
// Sleep for a number of milliseconds
|
|
CZMQ_EXPORT void
|
|
zclock_sleep (int msecs);
|
|
|
|
// Return current system clock as milliseconds\&. Note that this clock can
|
|
// jump backwards (if the system clock is changed) so is unsafe to use for
|
|
// timers and time offsets\&. Use zclock_mono for that instead\&.
|
|
CZMQ_EXPORT int64_t
|
|
zclock_time (void);
|
|
|
|
// Return current monotonic clock in milliseconds\&. Use this when you compute
|
|
// time offsets\&. The monotonic clock is not affected by system changes and
|
|
// so will never be reset backwards, unlike a system clock\&.
|
|
CZMQ_EXPORT int64_t
|
|
zclock_mono (void);
|
|
|
|
// Return current monotonic clock in microseconds\&. Use this when you compute
|
|
// time offsets\&. The monotonic clock is not affected by system changes and
|
|
// so will never be reset backwards, unlike a system clock\&.
|
|
CZMQ_EXPORT int64_t
|
|
zclock_usecs (void);
|
|
|
|
// Return formatted date/time as fresh string\&. Free using zstr_free()\&.
|
|
// Caller owns return value and must destroy it when done\&.
|
|
CZMQ_EXPORT char *
|
|
zclock_timestr (void);
|
|
|
|
// Self test of this class\&.
|
|
CZMQ_EXPORT void
|
|
zclock_test (bool verbose);
|
|
|
|
Please add \*(Aq@interface\*(Aq section in \*(Aq\&./\&.\&./src/zclock\&.c\*(Aq\&.
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
The zclock class provides essential sleep and system time functions, used to slow down threads for testing, and calculate timers for polling\&. Wraps the non\-portable system calls in a simple portable API\&.
|
|
.sp
|
|
The Win32 Sleep() call defaults to 16ms resolution unless the system timer resolution is increased with a call to timeBeginPeriod() permitting 1ms granularity\&.
|
|
.SH "EXAMPLE"
|
|
.PP
|
|
\fBFrom zclock_test method\fR.
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
int64_t start = zclock_time ();
|
|
zclock_sleep (10);
|
|
assert ((zclock_time () \- start) >= 10);
|
|
start = zclock_mono ();
|
|
int64_t usecs = zclock_usecs ();
|
|
zclock_sleep (10);
|
|
assert ((zclock_mono () \- start) >= 10);
|
|
assert ((zclock_usecs () \- usecs) >= 10000);
|
|
char *timestr = zclock_timestr ();
|
|
if (verbose)
|
|
puts (timestr);
|
|
free (timestr);
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.sp
|
|
.SH "AUTHORS"
|
|
.sp
|
|
The czmq manual was written by the authors in the AUTHORS file\&.
|
|
.SH "RESOURCES"
|
|
.sp
|
|
Main web site: \m[blue]\fB\%\fR\m[]
|
|
.sp
|
|
Report bugs to the email <\m[blue]\fBzeromq\-dev@lists\&.zeromq\&.org\fR\m[]\&\s-2\u[1]\d\s+2>
|
|
.SH "COPYRIGHT"
|
|
.sp
|
|
Copyright (c) the Contributors as noted in the AUTHORS file\&. This file is part of CZMQ, the high\-level C binding for 0MQ: http://czmq\&.zeromq\&.org\&. This Source Code Form is subject to the terms of the Mozilla Public License, v\&. 2\&.0\&. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla\&.org/MPL/2\&.0/\&. LICENSE included with the czmq distribution\&.
|
|
.SH "NOTES"
|
|
.IP " 1." 4
|
|
zeromq-dev@lists.zeromq.org
|
|
.RS 4
|
|
\%mailto:zeromq-dev@lists.zeromq.org
|
|
.RE
|
|
|