blob: 14cd39b6339d3fc28f0411fe78c0bcff205439fd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */
/*
** File: prinrval.h
** Description: API to interval timing functions of NSPR.
**
**
** NSPR provides interval times that are independent of network time
** of day values. Interval times are (in theory) accurate regardless
** of host processing requirements and also very cheap to acquire. It
** is expected that getting an interval time while in a synchronized
** function (holding one's lock).
**/
#if !defined(prinrval_h)
#define prinrval_h
#include "prtypes.h"
PR_BEGIN_EXTERN_C
/**********************************************************************/
/************************* TYPES AND CONSTANTS ************************/
/**********************************************************************/
typedef PRUint32 PRIntervalTime;
/***********************************************************************
** DEFINES: PR_INTERVAL_MIN
** PR_INTERVAL_MAX
** DESCRIPTION:
** These two constants define the range (in ticks / second) of the
** platform dependent type, PRIntervalTime. These constants bound both
** the period and the resolution of a PRIntervalTime.
***********************************************************************/
#define PR_INTERVAL_MIN 1000UL
#define PR_INTERVAL_MAX 100000UL
/***********************************************************************
** DEFINES: PR_INTERVAL_NO_WAIT
** PR_INTERVAL_NO_TIMEOUT
** DESCRIPTION:
** Two reserved constants are defined in the PRIntervalTime namespace.
** They are used to indicate that the process should wait no time (return
** immediately) or wait forever (never time out), respectively.
** Note: PR_INTERVAL_NO_TIMEOUT passed as input to PR_Connect is
** interpreted as use the OS's connect timeout.
**
***********************************************************************/
#define PR_INTERVAL_NO_WAIT 0UL
#define PR_INTERVAL_NO_TIMEOUT 0xffffffffUL
/**********************************************************************/
/****************************** FUNCTIONS *****************************/
/**********************************************************************/
/***********************************************************************
** FUNCTION: PR_IntervalNow
** DESCRIPTION:
** Return the value of NSPR's free running interval timer. That timer
** can be used to establish epochs and determine intervals (be computing
** the difference between two times).
** INPUTS: void
** OUTPUTS: void
** RETURN: PRIntervalTime
**
** SIDE EFFECTS:
** None
** RESTRICTIONS:
** The units of PRIntervalTime are platform dependent. They are chosen
** such that they are appropriate for the host OS, yet provide sufficient
** resolution and period to be useful to clients.
** MEMORY: N/A
** ALGORITHM: Platform dependent
***********************************************************************/
NSPR_API(PRIntervalTime) PR_IntervalNow(void);
/***********************************************************************
** FUNCTION: PR_TicksPerSecond
** DESCRIPTION:
** Return the number of ticks per second for PR_IntervalNow's clock.
** The value will be in the range [PR_INTERVAL_MIN..PR_INTERVAL_MAX].
** INPUTS: void
** OUTPUTS: void
** RETURN: PRUint32
**
** SIDE EFFECTS:
** None
** RESTRICTIONS:
** None
** MEMORY: N/A
** ALGORITHM: N/A
***********************************************************************/
NSPR_API(PRUint32) PR_TicksPerSecond(void);
/***********************************************************************
** FUNCTION: PR_SecondsToInterval
** PR_MillisecondsToInterval
** PR_MicrosecondsToInterval
** DESCRIPTION:
** Convert standard clock units to platform dependent intervals.
** INPUTS: PRUint32
** OUTPUTS: void
** RETURN: PRIntervalTime
**
** SIDE EFFECTS:
** None
** RESTRICTIONS:
** Conversion may cause overflow, which is not reported.
** MEMORY: N/A
** ALGORITHM: N/A
***********************************************************************/
NSPR_API(PRIntervalTime) PR_SecondsToInterval(PRUint32 seconds);
NSPR_API(PRIntervalTime) PR_MillisecondsToInterval(PRUint32 milli);
NSPR_API(PRIntervalTime) PR_MicrosecondsToInterval(PRUint32 micro);
/***********************************************************************
** FUNCTION: PR_IntervalToSeconds
** PR_IntervalToMilliseconds
** PR_IntervalToMicroseconds
** DESCRIPTION:
** Convert platform dependent intervals to standard clock units.
** INPUTS: PRIntervalTime
** OUTPUTS: void
** RETURN: PRUint32
**
** SIDE EFFECTS:
** None
** RESTRICTIONS:
** Conversion may cause overflow, which is not reported.
** MEMORY: N/A
** ALGORITHM: N/A
***********************************************************************/
NSPR_API(PRUint32) PR_IntervalToSeconds(PRIntervalTime ticks);
NSPR_API(PRUint32) PR_IntervalToMilliseconds(PRIntervalTime ticks);
NSPR_API(PRUint32) PR_IntervalToMicroseconds(PRIntervalTime ticks);
PR_END_EXTERN_C
#endif /* !defined(prinrval_h) */
/* prinrval.h */
|
