| /curl/docs/libcurl/opts/ |
| H A D | CURLMOPT_SOCKETFUNCTION.md | 18 CURLMOPT_SOCKETFUNCTION - callback informed about what to wait for
28 void *clientp, /* private callback pointer */
36 Pass a pointer to your callback function, which should match the prototype
40 callback to inform the application about updates in the socket (file
43 since the previous time the callback was called. If the given callback pointer
44 is set to NULL, no callback is called.
63 The socket callback should return 0 on success, and -1 on error. If this
64 callback returns error, **all** transfers currently in progress in this
71 The **what** parameter informs the callback on the status of the given
94 NULL (no callback)
[all …]
|
| H A D | CURLMOPT_TIMERFUNCTION.md | 17 CURLMOPT_TIMERFUNCTION - callback to receive timeout values
26 void *clientp); /* private callback pointer */
33 Pass a pointer to your callback function, which should match the prototype
39 Your callback function **timer_callback** should install a single
44 If this callback is called when a timer is already running, this new expire
48 A **timeout_ms** value of -1 passed to this callback means you should delete
55 The timer callback should return 0 on success, and -1 on error. If this
56 callback returns error, **all** transfers currently in progress in this multi
59 This callback can be used instead of, or in addition to,
62 **WARNING:** do not call libcurl directly from within the callback itself when
[all …]
|
| H A D | CURLOPT_XFERINFOFUNCTION.md | 17 CURLOPT_XFERINFOFUNCTION - progress meter callback
36 Pass a pointer to your callback function, which should match the prototype
45 used by libcurl but is only passed along from the application to the callback.
47 The callback gets told how much data libcurl is about to transfer and has
54 Unknown/unused argument values passed to the callback are set to zero (like if
55 you only download data, the upload size remains 0). Many times the callback is
59 Return zero from the callback if everything is fine.
61 Return 1 from this callback to make libcurl abort the transfer and return
64 If your callback function returns CURL_PROGRESSFUNC_CONTINUE it makes libcurl
108 /* pass struct to callback */
[all …]
|
| H A D | CURLOPT_HSTSREADFUNCTION.md | 19 CURLOPT_HSTSREADFUNCTION - read callback for HSTS hosts
40 Pass a pointer to your callback function, as the prototype shows above.
42 This callback function gets called by libcurl repeatedly when it populates the
48 When this callback is invoked, the *sts* pointer points to a populated
54 The callback should return *CURLSTS_OK* if it returns a name and is
65 NULL - no callback.
90 /* set HSTS read callback */
93 /* pass in suitable argument to the callback */
|
| H A D | CURLMOPT_PUSHFUNCTION.md | 19 CURLMOPT_PUSHFUNCTION - callback that approves or denies server pushes
38 This callback gets called when a new HTTP/2 stream is being pushed by the
39 server (using the PUSH_PROMISE frame). If no push callback is set, all offered
44 The callback gets its arguments like this:
58 headers, the normal response headers are provided in the header callback as
63 If the callback returns CURL_PUSH_OK, the new easy handle is added to the
64 multi handle, the callback must not do that by itself.
66 The callback can access PUSH_PROMISE headers with two accessor
70 header callback for pushed streams just as for normal streams.
84 The callback denies the stream and no data reaches the application, the easy
[all …]
|
| H A D | CURLOPT_WRITEFUNCTION.md | 18 CURLOPT_WRITEFUNCTION - callback for writing received data
32 Pass a pointer to your callback function, which should match the prototype
35 This callback function gets called by libcurl as soon as there is data
42 The callback function is passed as much data as possible in all invokes, but
45 callback is defined in the curl.h header file: *CURL_MAX_WRITE_SIZE* (the
47 data get passed to the write callback, you can get up to
56 Your callback should return the number of bytes actually taken care of. If
57 that amount differs from the amount passed to your callback function, it
64 If the callback function returns CURL_WRITEFUNC_PAUSE it pauses this
68 your callback. The internal default function writes the data to the FILE *
[all …]
|
| H A D | CURLOPT_PROGRESSFUNCTION.md | 18 CURLOPT_PROGRESSFUNCTION - progress meter callback
37 Pass a pointer to your callback function, which should match the prototype
49 used by libcurl but is only passed along from the application to the callback.
51 The callback gets told how much data libcurl is about to transfer and has
58 Unknown/unused argument values passed to the callback are be set to zero (like
59 if you only download data, the upload size remains 0). Many times the callback
63 Return zero from the callback if everything is fine.
65 If your callback function returns CURL_PROGRESSFUNC_CONTINUE it causes libcurl
68 Return 1 from this callback to make libcurl abort the transfer and return
112 /* pass struct to callback */
|
| H A D | CURLOPT_HSTSWRITEFUNCTION.md | 19 CURLOPT_HSTSWRITEFUNCTION - write callback for HSTS hosts
46 Pass a pointer to your callback function, as the prototype shows above.
48 This callback function gets called by libcurl repeatedly to allow the
54 When the callback is invoked, the *sts* pointer points to a populated
60 The callback should return *CURLSTS_OK* if it succeeded and is prepared to
69 NULL - no callback.
94 /* set HSTS read callback */
97 /* pass in suitable argument to the callback */
|
| H A D | CURLOPT_RESOLVER_START_FUNCTION.md | 17 CURLOPT_RESOLVER_START_FUNCTION - callback called before a new name resolve is started
33 Pass a pointer to your callback function, which should match the prototype
36 This callback function gets called by libcurl every time before a new resolve
42 socket callback options.
49 The callback must return 0 on success. Returning a non-zero value causes the
54 NULL (No callback)
|
| H A D | CURLOPT_HEADERFUNCTION.md | 22 CURLOPT_HEADERFUNCTION - callback that receives header data
40 Pass a pointer to your callback function, which should match the prototype
43 This callback function gets invoked by libcurl as soon as it has received
44 header data. The header callback is called once for each header and only
45 complete header lines are passed on to the callback. Parsing headers is easy
46 to do using this callback. *buffer* points to the delivered data, and the
53 Your callback should return the number of bytes actually taken care of. If
54 that amount differs from the amount passed to your callback function, it
69 It is important to note that the callback is invoked for the headers of all
73 response, you need to collect headers in the callback yourself and use HTTP
[all …]
|
| H A D | CURLOPT_SSL_CTX_FUNCTION.md | 26 CURLOPT_SSL_CTX_FUNCTION - SSL context callback
41 Pass a pointer to your callback function, which should match the prototype
44 This callback function gets called by libcurl just before the initialization
50 returned from the callback no attempt to establish a connection is made and
51 the perform operation returns the callback's error code. Set the *clientp*
52 argument passed in to this callback with the CURLOPT_SSL_CTX_DATA(3) option.
66 The CURLOPT_SSL_CTX_FUNCTION(3) callback allows the application to reach in
70 CURLOPT_FORBID_REUSE(3) from the callback function.
73 callback is also called for those transfers and the curl handle is set to an
81 callback function has returned. Your application must not assume that it can
[all …]
|
| H A D | CURLOPT_READDATA.md | 19 CURLOPT_READDATA - pointer passed to the read callback
33 the fourth argument to the callback.
35 If you do not specify a read callback but instead rely on the default internal
39 CURLOPT_READFUNCTION(3) callback if you set this option, otherwise you
63 CURLOPT_READFUNCTION callback */
|
| H A D | CURLSHOPT_UNLOCKFUNC.md | 19 CURLSHOPT_UNLOCKFUNC - mutex unlock callback
33 Set a mutex unlock callback for the share object. There is a corresponding
34 CURLSHOPT_LOCKFUNC(3) callback called when the mutex is first locked.
37 prototype shown above. The arguments to the callback are:
43 sure that the callback uses a different lock for each kind of data.
|
| H A D | CURLOPT_OPENSOCKETFUNCTION.md | 18 CURLOPT_OPENSOCKETFUNCTION - callback for opening socket
46 Pass a pointer to your callback function, which should match the prototype
49 This callback function gets called by libcurl instead of the *socket(2)*
50 call. The callback's *purpose* argument identifies the exact purpose for
58 The callback gets the resolved peer address as the *address* argument and
59 is allowed to modify the address or refuse to connect completely. The callback
63 the user's discretion. A *CURL_SOCKET_BAD* return value from the callback
65 *CURLE_COULDNT_CONNECT* from the function that triggered this callback.
69 the socket back with this callback and then use
|
| H A D | CURLOPT_SOCKOPTFUNCTION.md | 18 CURLOPT_SOCKOPTFUNCTION - callback for setting socket options
45 Pass a pointer to your callback function, which should match the prototype
48 When set, this callback function gets called by libcurl when the socket has
50 specific socket options. The callback's *purpose* argument identifies the
55 (in earlier versions these sockets were not passed to this callback).
58 created socket descriptor to the callback in the *curlfd* parameter so
64 Return *CURL_SOCKOPT_OK* from the callback on success. Return
65 *CURL_SOCKOPT_ERROR* from the callback function to signal an unrecoverable
67 *CURLE_COULDNT_CONNECT*. Alternatively, the callback function can return
|
| H A D | CURLOPT_WRITEDATA.md | 18 CURLOPT_WRITEDATA - pointer passed to the write callback
30 A data *pointer* to pass to the write callback. If you use the
32 callback's fourth and last argument. If you do not use a write callback, you
51 A common technique is to use the write callback to store the incoming data
|
| H A D | CURLOPT_IOCTLFUNCTION.md | 17 CURLOPT_IOCTLFUNCTION - callback for I/O operations
26 CURLIOE_UNKNOWNCMD, /* command was unknown to callback */
44 Pass a pointer to your callback function, which should match the prototype
47 This callback function gets called by libcurl when something special
53 The callback MUST return *CURLIOE_UNKNOWNCMD* if the input *cmd* is
56 The *clientp* argument to the callback is set with the
|
| H A D | CURLOPT_READFUNCTION.md | 21 CURLOPT_READFUNCTION - read callback for data uploads
35 Pass a pointer to your callback function, as the prototype shows above.
37 This callback function gets called by libcurl as soon as it needs to read data
54 The read callback may return *CURL_READFUNC_ABORT* to stop the current
58 The callback can return *CURL_READFUNC_PAUSE* to cause reading from this
62 that the callback wants, or it is considered the final packet by the server
65 If you set this callback pointer to NULL, or do not set it at all, the default
106 /* set callback to use */
109 /* pass in suitable argument to callback */
|
| H A D | CURLSHOPT_LOCKFUNC.md | 19 CURLSHOPT_LOCKFUNC - mutex lock callback
34 Set a mutex lock callback for the share object, to allow it to get used by
36 CURLSHOPT_UNLOCKFUNC(3) callback called when the mutex is again released.
39 prototype shown above. The arguments to the callback are:
45 sure that the callback uses a different lock for each kind of data.
|
| H A D | CURLMOPT_SOCKETDATA.md | 18 CURLMOPT_SOCKETDATA - custom pointer passed to the socket callback
30 A data *pointer* to pass to the socket callback set with the
34 callback's **clientp** argument.
71 /* ... use socket callback and custom pointer */
|
| H A D | CURLOPT_PROGRESSDATA.md | 17 CURLOPT_PROGRESSDATA - pointer passed to the progress callback
30 argument in the progress callback set with CURLOPT_PROGRESSFUNCTION(3).
66 /* pass struct to callback */
|
| H A D | CURLOPT_SEEKDATA.md | 19 CURLOPT_SEEKDATA - pointer passed to the seek callback
31 Data *pointer* to pass to the seek callback function. If you use the
36 If you do not set this, NULL is passed to the callback.
|
| H A D | CURLOPT_HEADERDATA.md | 18 CURLOPT_HEADERDATA - pointer to pass to header callback
34 *pointer* is passed in to the respective callback.
62 /* now this callback can access the my_info struct */
76 /* pass in custom data to the callback */
|
| /curl/docs/libcurl/ |
| H A D | curl_mime_data_cb.md | 21 curl_mime_data_cb - set a callback-based data source for a mime part's body
43 from a data read callback function.
47 *readfunc* is a pointer to a data read callback function, with a signature
50 *seekfunc* is a pointer to a seek callback function, with a signature as
55 *freefunc* is a pointer to a user resource freeing callback function, with
60 *arg* is a user defined argument to callback functions.
62 The read callback function gets called by libcurl as soon as it needs to
77 The read callback may return *CURL_READFUNC_ABORT* to stop the current
81 The callback can return *CURL_READFUNC_PAUSE* to cause reading from this
89 The callback function must return *CURL_SEEKFUNC_OK* on success,
[all …]
|
| H A D | curl_ws_meta.md | 34 When the write callback (CURLOPT_WRITEFUNCTION(3)) is invoked on
36 the callback to provide additional information about the current frame.
38 This function only works from within the callback, and only when receiving
43 to the callback by libcurl itself, applications that want to use
44 curl_ws_meta(3) need to pass it on to the callback on its own.
107 /* we pass a pointer to this struct to the callback */
143 information that is valid for this specific callback invocation. If it cannot
|
