xref: /third_party/curl/lib/timediff.h (revision 13498266)
1#ifndef HEADER_CURL_TIMEDIFF_H
2#define HEADER_CURL_TIMEDIFF_H
3/***************************************************************************
4 *                                  _   _ ____  _
5 *  Project                     ___| | | |  _ \| |
6 *                             / __| | | | |_) | |
7 *                            | (__| |_| |  _ <| |___
8 *                             \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11 *
12 * This software is licensed as described in the file COPYING, which
13 * you should have received as part of this distribution. The terms
14 * are also available at https://curl.se/docs/copyright.html.
15 *
16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17 * copies of the Software, and permit persons to whom the Software is
18 * furnished to do so, under the terms of the COPYING file.
19 *
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
22 *
23 * SPDX-License-Identifier: curl
24 *
25 ***************************************************************************/
26
27#include "curl_setup.h"
28
29/* Use a larger type even for 32 bit time_t systems so that we can keep
30   microsecond accuracy in it */
31typedef curl_off_t timediff_t;
32#define CURL_FORMAT_TIMEDIFF_T CURL_FORMAT_CURL_OFF_T
33
34#define TIMEDIFF_T_MAX CURL_OFF_T_MAX
35#define TIMEDIFF_T_MIN CURL_OFF_T_MIN
36
37/*
38 * Converts number of milliseconds into a timeval structure.
39 *
40 * Return values:
41 *    NULL IF tv is NULL or ms < 0 (eg. no timeout -> blocking select)
42 *    tv with 0 in both fields IF ms == 0 (eg. 0ms timeout -> polling select)
43 *    tv with converted fields IF ms > 0 (eg. >0ms timeout -> waiting select)
44 */
45struct timeval *curlx_mstotv(struct timeval *tv, timediff_t ms);
46
47/*
48 * Converts a timeval structure into number of milliseconds.
49 */
50timediff_t curlx_tvtoms(struct timeval *tv);
51
52#endif /* HEADER_CURL_TIMEDIFF_H */
53