doc/tclcurl_share.html

   1 <HTML><HEAD><TITLE>Manpage of TclCurl</TITLE>
   2 </HEAD><BODY>
   3 <H1>TclCurl</H1>
   4 Section: TclCurl share data api (n)<BR>Updated: 03 October 2011<BR><HR>
   5
   6 <A NAME="lbAB">&nbsp;</A>
   7 <H2>NAME</H2>
   8 TclCurl: - get  a  URL with FTP, FTPS, HTTP, HTTPS, SCP, SFTP, TFTP, TELNET, DICT, FILE, LDAP,
   9 LDAPS, IMAP, IMAPS, POP, POP3, SMTP, SMTPS and gopher syntax.
  10 <A NAME="lbAC">&nbsp;</A>
  11 <H2>SYNOPSIS</H2>
  12
  13 <B>curl::shareinit</B>
  14
  15 <P>
  16 <I>shareHandle</I><B> share </B><I>?data?</I>
  17
  18 <P>
  19 <I>shareHandle</I><B> unshare </B><I>?data?</I>
  20
  21 <P>
  22 <I>shareHandle</I><B> cleanup</B>
  23
  24 <P>
  25 <B>curl::sharestrerror </B><I>errorCode</I>
  26
  27 <P>
  28 <P>
  29 <A NAME="lbAD">&nbsp;</A>
  30 <H2>DESCRIPTION</H2>
  31
  32 <P>
  33 With the share API, you can have two or more 'easy' handles sharing data
  34 among them, so far they can only share cookies and DNS data.
  35 <P>
  36 <A NAME="lbAE">&nbsp;</A>
  37 <H2>curl::shareinit</H2>
  38
  39 This procedure must be the first one to call, it returns a <B>shareHandle</B>
  40 that you need to use to share data among handles using the <B>-share</B> option
  41 to the <B>configure</B> command. The init MUST have a corresponding call to
  42 <B>cleanup</B> when the operation is completed.
  43 <P>
  44 <B>RETURN VALUE</B>
  45
  46 <P>
  47 <B>shareHandle</B> to use.
  48 <P>
  49 <A NAME="lbAF">&nbsp;</A>
  50 <H2>shareHandle share ?data?</H2>
  51
  52 <P>
  53 The parameter specifies a type of data that should be shared. This may be set
  54 to one of the values described below:
  55 <P>
  56 <DL COMPACT><DT><DD>
  57 <DL COMPACT>
  58 <DT><B>cookies</B>
  59
  60 <DD>
  61 Cookie data will be shared across the easy handles using this shared object.
  62 <P>
  63 <DT><B>dns</B>
  64
  65 <DD>
  66 Cached DNS hosts will be shared across the easy handles using this shared object.
  67 </DL>
  68 </DL>
  69
  70 <P>
  71 <A NAME="lbAG">&nbsp;</A>
  72 <H2>shareHandle unshare ?data?</H2>
  73
  74 This command does the opposite of <B>share</B>. The specified parameter will no
  75 longer be shared. Valid values are the same as those for <B>share</B>.
  76 <P>
  77 <A NAME="lbAH">&nbsp;</A>
  78 <H2>sharehandle cleanup</H2>
  79
  80 <P>
  81 Deletes a shared object. The share handle cannot be used anymore after this
  82 function has been called.
  83 <P>
  84 <A NAME="lbAI">&nbsp;</A>
  85 <H2>curl::sharestrerror errorCode</H2>
  86
  87 Returns a string describing the error code passed in the argument.
  88 <P>
  89 <A NAME="lbAJ">&nbsp;</A>
  90 <H2>SEE ALSO</H2>
  91
  92 <I>curl, TclCurl</I>
  93
  94 <P>
  95
  96 <HR>
  97 <A NAME="index">&nbsp;</A><H2>Index</H2>
  98 <DL>
  99 <DT><A HREF="#lbAB">NAME</A><DD>
 100 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
 101 <DT><A HREF="#lbAD">DESCRIPTION</A><DD>
 102 <DT><A HREF="#lbAE">curl::shareinit</A><DD>
 103 <DT><A HREF="#lbAF">shareHandle share ?data?</A><DD>
 104 <DT><A HREF="#lbAG">shareHandle unshare ?data?</A><DD>
 105 <DT><A HREF="#lbAH">sharehandle cleanup</A><DD>
 106 <DT><A HREF="#lbAI">curl::sharestrerror errorCode</A><DD>
 107 <DT><A HREF="#lbAJ">SEE ALSO</A><DD>
 108 </DL>
 109 <HR>
 110 This document was created by man2html, using the manual pages.<BR>
 111 </BODY>
 112 </HTML>