<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - cURL Http/Ftp library binding.</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="prev"><a href="conio.html">Previous: conbox</a></li>
<li class="next"><a href="curl_CurlError.html">Next: Class CurlError</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">7</span>cURL Http/Ftp library binding.</h1><p>This module provides a tight and complete integration with the <a href="http://curl.haxx.se/libcurl/" target="_blank">libcurl</a> library. </p>
<p>Libcurl provides a complete set of RFC Internet protocol clients and allows a Falcon program to download remote files through simple commands. </p>
<p>The curl Falcon module is structured in a way that allows to handle multiple downloads in a single thread, and even in a simple coroutine, simplifying by orders of magnitude the complexity of sophisticated client programs. </p>
<h2><a name="code_status">Status of this binding.</a></h2>
<p>Currently the <b>curl</b> module presents a minimal interface to the underlying libCURL. The library is actually served through Falcon-wise objects and structures. Some of the most advanced features in the library are still not bound, but you'll find everything you need to upload or download files, send POST http requests, get transfer information and basically manage multiplexed transfers. </p>
<p>More advance binding is scheduled for the next version of this library, that will take advantage of a new binding engine in Falcon 0.9.8. </p>
<h2><a name="load_request">Importing the curl module.</a></h2>
<p>Since the names of the classes that are declared in this module are short and simple, it is advisable to use the <b>import</b> directive to store the module in its own namespace. For example: </p>
<pre>
import from curl
h = curl.Handle()
</pre><h2><a name="enums">Libcurl enumerations.</a></h2>
<p>The library wrapped by this module, libcurl, uses various sets of <b>define</b> directives to specify parameters and configure connection values. </p>
<p>To reduce the complexity of this module, each set of enumerations is stored in a different Falcon enumerative class. For example, all the options starting with "CURLOPT_" are stored in the OPT enumeration. The option that sets the overall operation timeout for a given curl handle can be set through the OPT.TIMEOUT option (which corresponds to the CURLOPT_TIMEOUT define in the original C API of libcurl). </p>
<h2>Contents of this module</h2><ul class="TOC"><li><span class="toc_number">7.1</span><a href="curl_CurlError.html">Class CurlError</a> - Error generated by cURL while operating. </li>
<li><span class="toc_number">7.2</span><a href="curl_Handle.html">Class Handle</a> - Stores an handle for a CURL (easy) connection. </li>
<li><span class="toc_number">7.3</span><a href="curl_Multi.html">Class Multi</a> - Interface to CURL multi_* operations. </li>
<li><span class="toc_number">7.4</span><a href="curl_function.html">Functions</a></li>
</ul></div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="prev"><a href="conio.html">Previous: conbox</a></li>
<li class="next"><a href="curl_CurlError.html">Next: Class CurlError</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
