CURLSHOPT_LOCKFUNC - mutex lock callback
#include <curl/curl.h> void lockcb(CURL *handle, curl_lock_data data, curl_lock_access access, void *userptr); CURLSHcode curl_share_setopt(CURLSH *share, CURLSHOPT_LOCKFUNC, lockcb);
CURLSHOPT_LOCKFUNC(3) libcurl Manual CURLSHOPT_LOCKFUNC(3)
NAME
CURLSHOPT_LOCKFUNC - mutex lock callback
SYNOPSIS
#include <curl/curl.h>
void lockcb(CURL *handle, curl_lock_data data, curl_lock_access access,
void *userptr);
CURLSHcode curl_share_setopt(CURLSH *share, CURLSHOPT_LOCKFUNC, lockcb);
DESCRIPTION
Set a mutex lock callback for the share object, to allow it to get used
by multiple threads concurrently. There's a corresponding CURL-
SHOPT_UNLOCKFUNC(3) callback called when the mutex is again released.
The lockcb argument must be a pointer to a function matching the proto-
type shown above. The arguments to the callback are:
handle is the currently active easy handle in use when the share object
is intended to get used.
The data argument tells what kind of data libcurl wants to lock. Make
sure that the callback uses a different lock for each kind of data.
access defines what access type libcurl wants, shared or single.
userptr is the private pointer you set with CURLSHOPT_USERDATA. This
pointer is not used by libcurl itself.
PROTOCOLS
All
EXAMPLE
CURLSHcode sh;
share = curl_share_init();
sh = curl_share_setopt(share, CURLSHOPT_LOCKFUNC, mutex_lock);
if(sh)
printf("Error: %s\n", curl_share_strerror(sh));
AVAILABILITY
Added in 7.10
RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero
means an error occurred. See libcurl-errors(3) for the full list with
descriptions.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | web/curl |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
CURLSHOPT_UNLOCKFUNC(3), curl_share_setopt(3), curl_share_cleanup(3),
curl_share_init(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://curl.se/down-
load/curl-7.83.1.tar.bz2.
Further information about this software can be found on the open source
community website at http://curl.haxx.se/.
libcurl 7.83.1 April 15, 2022 CURLSHOPT_LOCKFUNC(3)