1 #ifndef HEADER_CURL_PROGRESS_H 2 #define HEADER_CURL_PROGRESS_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 "timeval.h" 28 29 30 typedef enum { 31 TIMER_NONE, 32 TIMER_STARTOP, 33 TIMER_STARTSINGLE, /* start of transfer, might get queued */ 34 TIMER_POSTQUEUE, /* start, immediately after dequeue */ 35 TIMER_NAMELOOKUP, 36 TIMER_CONNECT, 37 TIMER_APPCONNECT, 38 TIMER_PRETRANSFER, 39 TIMER_STARTTRANSFER, 40 TIMER_POSTRANSFER, 41 TIMER_STARTACCEPT, 42 TIMER_REDIRECT, 43 TIMER_LAST /* must be last */ 44 } timerid; 45 46 int Curl_pgrsDone(struct Curl_easy *data); 47 void Curl_pgrsStartNow(struct Curl_easy *data); 48 void Curl_pgrsSetDownloadSize(struct Curl_easy *data, curl_off_t size); 49 void Curl_pgrsSetUploadSize(struct Curl_easy *data, curl_off_t size); 50 51 /* It is fine to not check the return code if 'size' is set to 0 */ 52 CURLcode Curl_pgrsSetDownloadCounter(struct Curl_easy *data, curl_off_t size); 53 54 void Curl_pgrsSetUploadCounter(struct Curl_easy *data, curl_off_t size); 55 void Curl_ratelimit(struct Curl_easy *data, struct curltime now); 56 int Curl_pgrsUpdate(struct Curl_easy *data); 57 void Curl_pgrsResetTransferSizes(struct Curl_easy *data); 58 struct curltime Curl_pgrsTime(struct Curl_easy *data, timerid timer); 59 timediff_t Curl_pgrsLimitWaitTime(curl_off_t cursize, 60 curl_off_t startsize, 61 curl_off_t limit, 62 struct curltime start, 63 struct curltime now); 64 /** 65 * Update progress timer with the elapsed time from its start to `timestamp`. 66 * This allows updating timers later and is used by happy eyeballing, where 67 * we only want to record the winner's times. 68 */ 69 void Curl_pgrsTimeWas(struct Curl_easy *data, timerid timer, 70 struct curltime timestamp); 71 72 #define PGRS_HIDE (1<<4) 73 #define PGRS_UL_SIZE_KNOWN (1<<5) 74 #define PGRS_DL_SIZE_KNOWN (1<<6) 75 #define PGRS_HEADERS_OUT (1<<7) /* set when the headers have been written */ 76 77 #endif /* HEADER_CURL_PROGRESS_H */ 78
