diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2003-08-11 07:25:02 +0000 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2003-08-11 07:25:02 +0000 |
| commit | 8fa43b469a221a6f87ade73b077a6178d6b8e4b7 (patch) | |
| tree | 274e8fec37d53816b2686ee80e91cefd58441784 /docs/libcurl/curl_share_setopt.3 | |
| parent | 894e52f61af1baac296a24b4e1c664cb4d4539bd (diff) | |
| download | curl-8fa43b469a221a6f87ade73b077a6178d6b8e4b7.tar.gz | |
documenting the share interface
Diffstat (limited to 'docs/libcurl/curl_share_setopt.3')
| -rw-r--r-- | docs/libcurl/curl_share_setopt.3 | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/libcurl/curl_share_setopt.3 b/docs/libcurl/curl_share_setopt.3 new file mode 100644 index 000000000..583c14645 --- /dev/null +++ b/docs/libcurl/curl_share_setopt.3 @@ -0,0 +1,46 @@ +.\" $Id$ +.\" +.TH curl_share_setopt 3 "8 Aug 2003" "libcurl 7.10.7" "libcurl Manual" +.SH NAME +curl_share_setopt - Set options for a shared object +.SH SYNOPSIS +.B #include <curl/curl.h> +.sp +CURLSHcode curl_share_setopt(CURLSH *share, CURLSHoption option, parameter); +.ad +.SH DESCRIPTION +Set the \fIoption\fP to \fIparameter\fP for the given \fIshare\fP. +.SH OPTIONS +.TP 0.4i +.B CURLSHOPT_LOCKFUNC +The \fIparameter\fP must be a pointer to a function matching the following +prototype: + +void lock_function(CURL *handle, curl_lock_data data, curl_lock_access access, +void *userptr); + +\fIdata\fP defines what data libcurl wants to lock, and you must make sure that +only one lock is given at any time for each kind of data. + +\fIaccess\fP defines what access type libcurl wants, shared or single. + +\fIuserptr\fP is the pointer you set with \fICURLSHOPT_USERDAT\fP. + +.TP +.B CURLSHOPT_UNLOCKFUNC +hej +.TP +.B CURLSHOPT_SHARE +hej +.TP +.B CURLSHOPT_UNSHARE +hej +.TP +.B CURLSHOPT_USERDATA +hej +.PP +.SH RETURN VALUE +If this function returns non-zero, something was wrong! + +.SH "SEE ALSO" +.BR curl_share_cleanup "(3), " curl_share_init "(3)" |