| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_PROGRESSFUNCTION 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_PROGRESSFUNCTION \- callback to progress meter function |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
int progress_callback(void *clientp, |
| 30 |
double dltotal, |
| 31 |
double dlnow, |
| 32 |
double ultotal, |
| 33 |
double ulnow); |
| 34 |
|
| 35 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROGRESSFUNCTION, progress_callback); |
| 36 |
.SH DESCRIPTION |
| 37 |
Pass a pointer to your callback function, which should match the prototype |
| 38 |
shown above. |
| 39 |
|
| 40 |
We encourage users to use the newer \fICURLOPT_XFERINFOFUNCTION(3)\fP instead, |
| 41 |
if you can. |
| 42 |
|
| 43 |
This function gets called by libcurl instead of its internal equivalent with a |
| 44 |
frequent interval. While data is being transferred it will be called very |
| 45 |
frequently, and during slow periods like when nothing is being transferred it |
| 46 |
can slow down to about one call per second. |
| 47 |
|
| 48 |
\fIclientp\fP is the pointer set with \fICURLOPT_PROGRESSDATA(3)\fP, it is not |
| 49 |
used by libcurl but is only passed along from the application to the callback. |
| 50 |
|
| 51 |
The callback gets told how much data libcurl will transfer and has |
| 52 |
transferred, in number of bytes. \fIdltotal\fP is the total number of bytes |
| 53 |
libcurl expects to download in this transfer. \fIdlnow\fP is the number of |
| 54 |
bytes downloaded so far. \fIultotal\fP is the total number of bytes libcurl |
| 55 |
expects to upload in this transfer. \fIulnow\fP is the number of bytes |
| 56 |
uploaded so far. |
| 57 |
|
| 58 |
Unknown/unused argument values passed to the callback will be set to zero |
| 59 |
(like if you only download data, the upload size will remain 0). Many times |
| 60 |
the callback will be called one or more times first, before it knows the data |
| 61 |
sizes so a program must be made to handle that. |
| 62 |
|
| 63 |
If your callback function returns CURL_PROGRESSFUNC_CONTINUE it will cause |
| 64 |
libcurl to continue executing the default progress function. |
| 65 |
|
| 66 |
Returning any other non-zero value from this callback will cause libcurl to |
| 67 |
abort the transfer and return \fICURLE_ABORTED_BY_CALLBACK\fP. |
| 68 |
|
| 69 |
If you transfer data with the multi interface, this function will not be |
| 70 |
called during periods of idleness unless you call the appropriate libcurl |
| 71 |
function that performs transfers. |
| 72 |
|
| 73 |
\fICURLOPT_NOPROGRESS(3)\fP must be set to 0 to make this function actually |
| 74 |
get called. |
| 75 |
.SH DEFAULT |
| 76 |
By default, libcurl has an internal progress meter. That's rarely wanted by |
| 77 |
users. |
| 78 |
.SH PROTOCOLS |
| 79 |
All |
| 80 |
.SH EXAMPLE |
| 81 |
https://curl.haxx.se/libcurl/c/progressfunc.html |
| 82 |
.SH AVAILABILITY |
| 83 |
Always |
| 84 |
.SH RETURN VALUE |
| 85 |
Returns CURLE_OK. |
| 86 |
.SH "SEE ALSO" |
| 87 |
.BR CURLOPT_VERBOSE "(3), " CURLOPT_NOPROGRESS "(3), " |