CURLOPT_IOCTLFUNCTION - Online Linux Manual PageSection : 3
Updated : October 31, 2021
Source : libcurl 7.82.0
Note : curl_easy_setopt options
NAMECURLOPT_IOCTLFUNCTION − callback for I/O operations
SYNOPSIS#include <curl/curl.h>
typedef enum {
CURLIOE_OK, /* I/O operation successful */
CURLIOE_UNKNOWNCMD, /* command was unknown to callback */
CURLIOE_FAILRESTART, /* failed to restart the read */
CURLIOE_LAST /* never use */
} curlioerr;
typedef enum {
CURLIOCMD_NOP, /* no operation */
CURLIOCMD_RESTARTREAD, /* restart the read stream from start */
CURLIOCMD_LAST /* never use */
} curliocmd;
curlioerr ioctl_callback(CURL *handle, int cmd, void *clientp);
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IOCTLFUNCTION, ioctl_callback);
DESCRIPTION
Pass a pointer to your callback function, which should match the prototype shown above. This callback function gets called by libcurl when something special I/O-related needs to be done that the library cannot do by itself. For now, rewinding the read data stream is the only action it can request. The rewinding of the read data stream may be necessary when doing an HTTP PUT or POST with a multi-pass authentication method. The callback MUST return CURLIOE_UNKNOWNCMD if the input cmd is not CURLIOCMD_RESTARTREAD. The clientp argument to the callback is set with the CURLOPT_IOCTLDATA(3) option. This option is deprecated! Do not use it. Use CURLOPT_SEEKFUNCTION(3) instead to provide seeking! If CURLOPT_SEEKFUNCTION(3) is set, this parameter will be ignored when seeking.
DEFAULTBy default, this parameter is set to NULL. Not used.
PROTOCOLSUsed with HTTP
EXAMPLEstatic curlioerr ioctl_callback(CURL *handle, int cmd, void *clientp)
{
struct data *io = (struct data *)clientp;
if(cmd == CURLIOCMD_RESTARTREAD) {
lseek(fd, 0, SEEK_SET);
current_offset = 0;
return CURLIOE_OK;
}
return CURLIOE_UNKNOWNCMD;
}
{
struct data ioctl_data;
curl_easy_setopt(curl, CURLOPT_IOCTLFUNCTION, ioctl_callback);
curl_easy_setopt(curl, CURLOPT_IOCTLDATA, &ioctl_data);
}
AVAILABILITYAdded in 7.12.3
RETURN VALUEReturns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
SEE ALSOCURLOPT_IOCTLDATA(3), CURLOPT_SEEKFUNCTION (3)," 0
Johanes Gumabo
Data Size : 6,697 byte
man-CURLOPT_IOCTLFUNCTION.3Build : 2024-12-05, 20:55 :
Visitor Screen : x
Visitor Counter ( page / site ) : 4 / 173,138
Visitor ID : :
Visitor IP : 18.188.211.246 :
Visitor Provider : AMAZON-02 :
Provider Position ( lat x lon ) : 39.962500 x -83.006100 : x
Provider Accuracy Radius ( km ) : 1000 :
Provider City : Columbus :
Provider Province : Ohio , : ,
Provider Country : United States :
Provider Continent : North America :
Visitor Recorder : Version :
Visitor Recorder : Library :
Online Linux Manual Page : Version : Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page : Library : lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page : Library : lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base : Version : Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base : Library : lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36
Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.