doc/tclcurl_share.n

   1 .\" You can view this file with:
   2 .\" nroff -man [file]
   3 .\" Adapted from libcurl docs by fandom@telefonica.net
   4 .TH TclCurl n "8 September 2008" "TclCurl 7.19.0" "TclCurl share data api"
   5 .SH NAME
   6 TclCurl: - get  a  URL with FTP, FTPS, HTTP, HTTPS, SCP, SFTP, TFTP, TELNET, DICT, FILE or LDAP syntax.
   7 .SH SYNOPSIS
   8 .BI "curl::shareinit"
   9 .sp
  10 .IB shareHandle " share " "?data?"
  11 .sp
  12 .IB shareHandle " unshare " "?data?"
  13 .sp
  14 .IB shareHandle " cleanup"
  15 .sp
  16 .BI "curl::sharestrerror " errorCode
  17
  18
  19 .SH DESCRIPTION
  20
  21 With the share API, you can have two or more 'easy' handles sharing data
  22 among them, so far they can only share cookies and DNS data.
  23
  24 .SH curl::shareinit
  25 This procedure must be the first one to call, it returns a \fBshareHandle\fP
  26 that you need to use to share data among handles using the \fB-share\fP option
  27 to the \fBconfigure\fP command. The init MUST have a corresponding call to
  28 \fBcleanup\fP when the operation is completed.
  29
  30 .B RETURN VALUE
  31 .sp
  32 \fBshareHandle\fP to use.
  33
  34 .SH shareHandle share ?data?
  35
  36 The parameter specifies a type of data that should be shared. This may be set
  37 to one of the values described below:
  38
  39 .RS
  40 .TP 5
  41 .B cookies
  42 Cookie data will be shared across the easy handles using this shared object.
  43
  44 .TP
  45 .B dns
  46 Cached DNS hosts will be shared across the easy handles using this shared object.
  47 Note that when you use the multi interface, all easy handles added to the same multi
  48 handle will share DNS cache by default without this having to be used!
  49 .RE
  50
  51 .SH shareHandle unshare ?data?
  52 This command does the opposite of \fBshare\fP. The specified parameter will no
  53 longer be shared. Valid values are the same as those for \fBshare\fP.
  54
  55 .SH sharehandle cleanup
  56
  57 Deletes a shared object. The share handle cannot be used anymore after this
  58 function has been called.
  59
  60 .SH curl::sharestrerror errorCode
  61 Returns a string describing the error code passed in the argument.
  62
  63 .SH "SEE ALSO"
  64 .I curl, TclCurl