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