PRIntervalTime

NSPR
About NSPR
NSPR API Reference
NSPR Build Instruction
NSPR Release Process
Introduction to NSPR
NSPR Types
Threads
1. Threading Types and Constants
2. Threading Functions
Process Initialization
Locks
1. Lock Type
2. Lock Functions
Condition Variables
1. Condition Variable Type
2. Condition Variable Functions
Monitors
1. Monitor Type
2. Monitor Functions
Cached Monitors
1. Cached Monitor Functions
I/O Types
I/O Functions
Network Addresses
1. Network Address Types and Constants
2. Network Address Functions
Atomic Operations
Interval Timing
1. Interval Time Type and Constants
2. Interval Functions
Date and Time
Memory Management Operations
1. Memory Allocation Functions
2. Memory Allocation Macros
String Operations
Floating Point Number to String Conversion
Linked Lists
1. Linked List Types
  1. PRCList
2. Linked List Macros
Dynamic Library Linking
Process Management and Interprocess Communication
1. Process Management Types and Constants
  1. PRProcess
  2. PRProcessAttr
2. Process Management Functions
  1. Setting the Attributes of a New Process
  2. Creating and Managing Processes
Logging
Named Shared Memory
1. Shared Memory Protocol
2. Named Shared Memory Functions
Anonymous Shared Memory
1. Anonymous Memory Protocol
2. Anonymous Shared Memory Functions
IPC Semaphores
1. IPC Semaphore Functions
Thread Pools
1. Thread Pool Types
2. Thread Pool Functions
Random Number Generator
1. Random Number Generator Function
Hash Tables
1. Hash Tables and Type Constants
2. Hash Table Functions
NSPR Error Handling
Contribute
2. The MDN Project

A platform-dependent type that represents a monotonically increasing integer--the NSPR runtime clock.

Syntax

Description

The units of PRIntervalTime are platform-dependent. They are chosen to be appropriate for the host OS, yet provide sufficient resolution and period to be useful to clients.

The increasing interval value represented by PRIntervalTime wraps. It should therefore never be used for intervals greater than approximately 6 hours. Interval times are accurate regardless of host processing requirements and are very cheap to acquire.

The constants PR_INTERVAL_MIN and PR_INTERVAL_MAX define a range in ticks per second. These constants bound both the period and the resolution of a PRIntervalTime object.

The reserved constants PR_INTERVAL_NO_WAIT and PR_INTERVAL_NO_TIMEOUT have special meaning for NSPR. They indicate that the process should wait no time (return immediately) or wait forever (never time out), respectively.

Important Note

The counters used for interval times are allowed to overflow. Since the sampling of the counter used to define an arbitrary epoch may have any 32-bit value, some care must be taken in the use of interval times. The proper coding style to test the expiration of an interval is as follows:

As long as the interval and the elapsed time (now - epoch) do not exceed half the namespace allowed by a PRIntervalTime (2³¹-1), the expression shown above provides the expected result even if the signs of now and epoch differ.

The resolution of a PRIntervalTime object is defined by the API. NSPR guarantees that there will be at least 1000 ticks per second and not more than 100000. At the maximum resolution of 10000 ticks per second, each tick represents 1/100000 of a second. At that rate, a 32-bit register will overflow in approximately 28 hours, making the maximum useful interval approximately 6 hours. Waiting on events more than half a day in the future must therefore be based on a calendar time.