YAZ  5.23.1
timing.h
Go to the documentation of this file.
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) Index Data.
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of Index Data nor the names of its contributors
13  * may be used to endorse or promote products derived from this
14  * software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
34 #ifndef YAZ_TIMING_H
35 #define YAZ_TIMING_H
36 
37 #include <yaz/yconfig.h>
38 
40 
43 typedef struct yaz_timing *yaz_timing_t;
44 
63 YAZ_EXPORT
64 yaz_timing_t yaz_timing_create(void);
65 
69 YAZ_EXPORT
70 void yaz_timing_start(yaz_timing_t t);
71 
78 YAZ_EXPORT
79 void yaz_timing_stop(yaz_timing_t t);
80 
85 YAZ_EXPORT
86 double yaz_timing_get_real(yaz_timing_t t);
87 
92 YAZ_EXPORT
93 double yaz_timing_get_user(yaz_timing_t t);
94 
99 YAZ_EXPORT
100 double yaz_timing_get_sys(yaz_timing_t t);
101 
104 YAZ_EXPORT
105 void yaz_timing_destroy(yaz_timing_t *tp);
106 
108 
109 #endif
110 /*
111  * Local variables:
112  * c-basic-offset: 4
113  * c-file-style: "Stroustrup"
114  * indent-tabs-mode: nil
115  * End:
116  * vim: shiftwidth=4 tabstop=8 expandtab
117  */
118 
yaz_timing_t yaz_timing_create(void)
create timing handle
Definition: timing.c:47
#define YAZ_END_CDECL
Definition: yconfig.h:57
void yaz_timing_start(yaz_timing_t t)
start timer
Definition: timing.c:81
double yaz_timing_get_real(yaz_timing_t t)
returns real time in seconds
Definition: timing.c:130
Header with fundamental macros.
void yaz_timing_destroy(yaz_timing_t *tp)
destroys timing handle
Definition: timing.c:145
double yaz_timing_get_sys(yaz_timing_t t)
returns system time in seconds
Definition: timing.c:140
double yaz_timing_get_user(yaz_timing_t t)
returns user time in seconds
Definition: timing.c:135
struct yaz_timing * yaz_timing_t
YAZ timing handle (opaque type)
Definition: timing.h:43
#define YAZ_BEGIN_CDECL
Definition: yconfig.h:56
void yaz_timing_stop(yaz_timing_t t)
stop timer
Definition: timing.c:106