include/yaz/timing.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2009 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
  28 /**
  29  * \file timing.h
  30  * \brief Timing Utilities
  31  */
  32
  33 #ifndef YAZ_TIMING_H
  34 #define YAZ_TIMING_H
  35
  36 #include <yaz/yconfig.h>
  37
  38 YAZ_BEGIN_CDECL
  39
  40 typedef struct yaz_timing *yaz_timing_t;
  41
  42 YAZ_EXPORT
  43 yaz_timing_t yaz_timing_create(void);
  44 YAZ_EXPORT
  45 void yaz_timing_start(yaz_timing_t t);
  46 YAZ_EXPORT
  47 void yaz_timing_stop(yaz_timing_t t);
  48 YAZ_EXPORT
  49 double yaz_timing_get_real(yaz_timing_t t);
  50 YAZ_EXPORT
  51 double yaz_timing_get_user(yaz_timing_t t);
  52 YAZ_EXPORT
  53 double yaz_timing_get_sys(yaz_timing_t t);
  54 YAZ_EXPORT
  55 void yaz_timing_destroy(yaz_timing_t *tp);
  56
  57 YAZ_END_CDECL
  58
  59 #endif
  60 /*
  61  * Local variables:
  62  * c-basic-offset: 4
  63  * indent-tabs-mode: nil
  64  * End:
  65  * vim: shiftwidth=4 tabstop=8 expandtab
  66  */
  67