docs/libcurl/libcurl-share.3

   1 .\" You can view this file with:
   2 .\" nroff -man [file]
   3 .\"
   4 .TH libcurl-share 3 "8 Aug 2003" "libcurl 7.10.7" "libcurl share interface"
   5 .SH NAME
   6 libcurl-share \- how to use the share interface
   7 .SH DESCRIPTION
   8 This is an overview on how to use the libcurl share interface in your C
   9 programs. There are specific man pages for each function mentioned in
  10 here.
  11
  12 All functions in the share interface are prefixed with curl_share.
  13
  14 .SH "OBJECTIVES"
  15 The share interface was added to enable sharing of data between curl
  16 \&"handles".
  17 .SH "ONE SET OF DATA - MANY TRANSFERS"
  18 You can have multiple easy handles share data between them. Have them update
  19 and use the \fBsame\fP cookie database or DNS cache! This way, each single
  20 transfer will take advantage from data updates made by the other transfer(s).
  21 .SH "SHARE OBJECT"
  22 You create a shared object with \fIcurl_share_init(3)\fP. It returns a handle
  23 for a newly created one.
  24
  25 You tell the shared object what data you want it to share by using
  26 \fIcurl_share_setopt(3)\fP. Currently you can only share DNS and/or COOKIE
  27 data.
  28
  29 Since you can use this share from multiple threads, and libcurl has no
  30 internal thread synchronization, you must provide mutex callbacks if you're
  31 using this multi-threaded. You set lock and unlock functions with
  32 \fIcurl_share_setopt(3)\fP too.
  33
  34 Then, you make an easy handle to use this share, you set the
  35 \fICURLOPT_SHARE\fP option with \fIcurl_easy_setopt(3)\fP, and pass in share
  36 handle. You can make any number of easy handles share the same share handle.
  37
  38 To make an easy handle stop using that particular share, you set
  39 \fICURLOPT_SHARE\fP to NULL for that easy handle. To make a handle stop
  40 sharing a particular data, you can \fICURLSHOPT_UNSHARE\fP it.
  41
  42 When you're done using the share, make sure that no easy handle is still using
  43 it, and call \fIcurl_share_cleanup(3)\fP on the handle.
  44 .SH "SEE ALSO"
  45 .BR curl_share_init "(3), " curl_share_setopt "(3), " curl_share_cleanup "(3)"