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