mirror of
https://codeberg.org/kiss-community/repo
synced 2024-12-23 07:40:11 -07:00
85 lines
2.5 KiB
Groff
85 lines
2.5 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_IOCTLFUNCTION.md
|
|
.TH CURLOPT_IOCTLFUNCTION 3 "2024-08-02" libcurl
|
|
.SH NAME
|
|
CURLOPT_IOCTLFUNCTION \- callback for I/O operations
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#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);
|
|
.fi
|
|
.SH 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 \fICURLIOE_UNKNOWNCMD\fP if the input \fIcmd\fP is
|
|
not \fICURLIOCMD_RESTARTREAD\fP.
|
|
|
|
The \fIclientp\fP argument to the callback is set with the
|
|
\fICURLOPT_IOCTLDATA(3)\fP option.
|
|
|
|
\fBThis option is deprecated\fP. Do not use it. Use \fICURLOPT_SEEKFUNCTION(3)\fP
|
|
instead to provide seeking! If \fICURLOPT_SEEKFUNCTION(3)\fP is set, this
|
|
parameter is ignored when seeking.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
This functionality affects all supported protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
#include <unistd.h> /* for lseek */
|
|
|
|
struct data {
|
|
int fd; /* our file descriptor */
|
|
};
|
|
|
|
static curlioerr ioctl_callback(CURL *handle, int cmd, void *clientp)
|
|
{
|
|
struct data *io = (struct data *)clientp;
|
|
if(cmd == CURLIOCMD_RESTARTREAD) {
|
|
lseek(io->fd, 0, SEEK_SET);
|
|
return CURLIOE_OK;
|
|
}
|
|
return CURLIOE_UNKNOWNCMD;
|
|
}
|
|
int main(void)
|
|
{
|
|
struct data ioctl_data;
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_IOCTLFUNCTION, ioctl_callback);
|
|
curl_easy_setopt(curl, CURLOPT_IOCTLDATA, &ioctl_data);
|
|
}
|
|
}
|
|
.fi
|
|
.SH DEPRECATED
|
|
Deprecated since 7.18.0.
|
|
.SH AVAILABILITY
|
|
Added in curl 7.12.3
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_IOCTLDATA (3),
|
|
.BR CURLOPT_SEEKFUNCTION (3)
|