lib/progress.h

   1 #ifndef HEADER_CURL_PROGRESS_H
   2 #define HEADER_CURL_PROGRESS_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2014, 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.haxx.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  ***************************************************************************/
  24
  25 #include "timeval.h"
  26
  27
  28 typedef enum {
  29   TIMER_NONE,
  30   TIMER_STARTOP,
  31   TIMER_STARTSINGLE,
  32   TIMER_NAMELOOKUP,
  33   TIMER_CONNECT,
  34   TIMER_APPCONNECT,
  35   TIMER_PRETRANSFER,
  36   TIMER_STARTTRANSFER,
  37   TIMER_POSTRANSFER,
  38   TIMER_STARTACCEPT,
  39   TIMER_REDIRECT,
  40   TIMER_LAST /* must be last */
  41 } timerid;
  42
  43 int Curl_pgrsDone(struct connectdata *);
  44 void Curl_pgrsStartNow(struct Curl_easy *data);
  45 void Curl_pgrsSetDownloadSize(struct Curl_easy *data, curl_off_t size);
  46 void Curl_pgrsSetUploadSize(struct Curl_easy *data, curl_off_t size);
  47 void Curl_pgrsSetDownloadCounter(struct Curl_easy *data, curl_off_t size);
  48 void Curl_pgrsSetUploadCounter(struct Curl_easy *data, curl_off_t size);
  49 int Curl_pgrsUpdate(struct connectdata *);
  50 void Curl_pgrsResetTimesSizes(struct Curl_easy *data);
  51 void Curl_pgrsTime(struct Curl_easy *data, timerid timer);
  52 long Curl_pgrsLimitWaitTime(curl_off_t cursize,
  53                             curl_off_t startsize,
  54                             curl_off_t limit,
  55                             struct timeval start,
  56                             struct timeval now);
  57
  58 /* Don't show progress for sizes smaller than: */
  59 #define LEAST_SIZE_PROGRESS BUFSIZE
  60
  61 #define PROGRESS_DOWNLOAD (1<<0)
  62 #define PROGRESS_UPLOAD   (1<<1)
  63 #define PROGRESS_DOWN_AND_UP (PROGRESS_UPLOAD | PROGRESS_DOWNLOAD)
  64
  65 #define PGRS_SHOW_DL (1<<0)
  66 #define PGRS_SHOW_UL (1<<1)
  67 #define PGRS_DONE_DL (1<<2)
  68 #define PGRS_DONE_UL (1<<3)
  69 #define PGRS_HIDE    (1<<4)
  70 #define PGRS_UL_SIZE_KNOWN (1<<5)
  71 #define PGRS_DL_SIZE_KNOWN (1<<6)
  72
  73 #define PGRS_HEADERS_OUT (1<<7) /* set when the headers have been written */
  74
  75
  76 #endif /* HEADER_CURL_PROGRESS_H */
  77