include/libdispatch/time.h File Reference

Go to the source code of this file.

Defines
#define	NSEC_PER_SEC   (uint64_t)1000000000
#define	NSEC_PER_MSEC   (uint64_t)1000000
#define	USEC_PER_SEC   (uint64_t)1000000
#define	NSEC_PER_USEC   (uint64_t)1000
#define	DISPATCH_TIME_NOW   0ull
#define	DISPATCH_TIME_FOREVER   (~0ull)
Typedefs
typedef uint64_t	dispatch_time_t
Functions
DISPATCH_EXPORT DISPATCH_NOTHROW dispatch_time_t	dispatch_time (dispatch_time_t when, int64_t delta)
DISPATCH_EXPORT DISPATCH_NOTHROW dispatch_time_t	dispatch_walltime (const struct timespec *when, int64_t delta)

---

Define Documentation

#define DISPATCH_TIME_FOREVER   (~0ull)

#define DISPATCH_TIME_NOW   0ull

#define NSEC_PER_MSEC   (uint64_t)1000000

#define NSEC_PER_SEC   (uint64_t)1000000000

#define NSEC_PER_USEC   (uint64_t)1000

#define USEC_PER_SEC   (uint64_t)1000000

---

Typedef Documentation

dispatch_time_t

An somewhat abstract representation of time; where zero means "now" and DISPATCH_TIME_FOREVER means "infinity" and every value in between is an opaque encoding.

---

Function Documentation

DISPATCH_EXPORT DISPATCH_NOTHROW dispatch_time_t dispatch_time	(	dispatch_time_t	when,
		int64_t	delta
	)

dispatch_time

Create dispatch_time_t relative to the default clock or modify an existing dispatch_time_t.

On Mac OS X the default clock is based on mach_absolute_time().

Parameters:

when	An optional dispatch_time_t to add nanoseconds to. If zero is passed, then dispatch_time() will use the result of mach_absolute_time().
delta	Nanoseconds to add.

Returns:

A new dispatch_time_t.

DISPATCH_EXPORT DISPATCH_NOTHROW dispatch_time_t dispatch_walltime	(	const struct timespec *	when,
		int64_t	delta
	)

dispatch_walltime

Create a dispatch_time_t using the wall clock.

On Mac OS X the wall clock is based on gettimeofday(3).

Parameters:

when	A struct timespect to add time to. If NULL is passed, then dispatch_walltime() will use the result of gettimeofday(3).
delta	Nanoseconds to add.

Returns:

A new dispatch_time_t.