JasPer  3.0.0
All Classes Files Functions Variables Typedefs Enumerations Macros Modules Pages
jas_tmr.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2004 Michael David Adams.
3  * All rights reserved.
4  */
5 
6 /* __START_OF_JASPER_LICENSE__
7  *
8  * JasPer License Version 2.0
9  *
10  * Copyright (c) 2001-2006 Michael David Adams
11  * Copyright (c) 1999-2000 Image Power, Inc.
12  * Copyright (c) 1999-2000 The University of British Columbia
13  *
14  * All rights reserved.
15  *
16  * Permission is hereby granted, free of charge, to any person (the
17  * "User") obtaining a copy of this software and associated documentation
18  * files (the "Software"), to deal in the Software without restriction,
19  * including without limitation the rights to use, copy, modify, merge,
20  * publish, distribute, and/or sell copies of the Software, and to permit
21  * persons to whom the Software is furnished to do so, subject to the
22  * following conditions:
23  *
24  * 1. The above copyright notices and this permission notice (which
25  * includes the disclaimer below) shall be included in all copies or
26  * substantial portions of the Software.
27  *
28  * 2. The name of a copyright holder shall not be used to endorse or
29  * promote products derived from the Software without specific prior
30  * written permission.
31  *
32  * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
33  * LICENSE. NO USE OF THE SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
34  * THIS DISCLAIMER. THE SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
35  * "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
36  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
37  * PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO
38  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
39  * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
40  * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
41  * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
42  * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. NO ASSURANCES ARE
43  * PROVIDED BY THE COPYRIGHT HOLDERS THAT THE SOFTWARE DOES NOT INFRINGE
44  * THE PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF ANY OTHER ENTITY.
45  * EACH COPYRIGHT HOLDER DISCLAIMS ANY LIABILITY TO THE USER FOR CLAIMS
46  * BROUGHT BY ANY OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL
47  * PROPERTY RIGHTS OR OTHERWISE. AS A CONDITION TO EXERCISING THE RIGHTS
48  * GRANTED HEREUNDER, EACH USER HEREBY ASSUMES SOLE RESPONSIBILITY TO SECURE
49  * ANY OTHER INTELLECTUAL PROPERTY RIGHTS NEEDED, IF ANY. THE SOFTWARE
50  * IS NOT FAULT-TOLERANT AND IS NOT INTENDED FOR USE IN MISSION-CRITICAL
51  * SYSTEMS, SUCH AS THOSE USED IN THE OPERATION OF NUCLEAR FACILITIES,
52  * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL
53  * SYSTEMS, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH
54  * THE FAILURE OF THE SOFTWARE OR SYSTEM COULD LEAD DIRECTLY TO DEATH,
55  * PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH
56  * RISK ACTIVITIES"). THE COPYRIGHT HOLDERS SPECIFICALLY DISCLAIM ANY
57  * EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES.
58  *
59  * __END_OF_JASPER_LICENSE__
60  */
61 
67 #ifndef JAS_TMR_H
68 #define JAS_TMR_H
69 
70 /* The configuration header file should be included first. */
71 #include <jasper/jas_config.h>
72 
73 #if defined(JAS_HAVE_SYS_TIME_H)
74 #include <sys/time.h>
75 #else
76 #include <time.h>
77 #endif
78 
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82 
92 #if defined(JAS_HAVE_GETTIMEOFDAY)
93 
94 typedef struct {
95  struct timeval start;
96  struct timeval stop;
97 } jas_tmr_t;
98 
99 #elif defined(JAS_HAVE_GETRUSAGE)
100 
101 typedef struct {
102  struct rusage start;
103  struct rusage stop;
104 } jas_tmr_t;
105 
106 #else
107 
108 typedef int jas_tmr_t;
109 
110 #endif
111 
115 JAS_EXPORT
116 void jas_tmr_start(jas_tmr_t *tmr);
117 
121 JAS_EXPORT
122 void jas_tmr_stop(jas_tmr_t *tmr);
123 
127 JAS_EXPORT
128 double jas_tmr_get(jas_tmr_t *tmr);
129 
134 #ifdef __cplusplus
135 }
136 #endif
137 
138 #endif
jas_tmr_get
double jas_tmr_get(jas_tmr_t *tmr)
Get the elapsed time for a timer.
Definition: jas_tmr.c:143
jas_tmr_t
Timer type.
jas_tmr_start
void jas_tmr_start(jas_tmr_t *tmr)
Start a timer.
Definition: jas_tmr.c:135
jas_tmr.h
Timer Code.
jas_tmr_stop
void jas_tmr_stop(jas_tmr_t *tmr)
Stop a timer.
Definition: jas_tmr.c:139