libcurl 接口调用方式

http://hi.baidu.com/tracyu1026/item/bb6d5def4292b10b570f1d48

 

libcurl提供了一组C语言API函数直接调用。首先需要提到的两个函数就是curl_global_init()和 curl_global_cleanup()。libcurl要用到一系列的全局常量，curl_global_init()函数就是初始化这些变量，并分配一些全局资源；curl_global_cleanup()则负责释放这些资源。因此一般情况下，在调用libcurl函数之前，先用 curl_global_init(CURL_GLOBAL_ALL)做初始化，在调用完毕后，用curl_global_cleanup()退出。

 

需要注意的是，这些全局变量和资源并不是线程安全的，因此，在多线程应用的环境中，最好不要多次调用curl_global_init()和curl_global_cleanup()，调用其他函数并不会改变这些全局变量和资源。

 

    libcurl支持3种不同的接口调用方式，分别是"easy"、"multi"和"share"模式。

 

libcurl-easy是一组同步接口，函数都 是curl_easy_*形式，这种模式调用curl_easy_perform()函数进行URL数据传输，直到传输完成函数才返回；

libcurl- multi是一组异步接口，函数都是curl_multi_*形式，调用curl_multi_perform()函数进行传输，但是每次调用只传一片数据，我们可以用select()函数控制多个下载任务进行同步下载，来实现在一个线程中同时下载多个文件；

libcurl-share允许在多线程中操作共享数据。下面以libcurl-easy为例讲一下libcurl的函数。
   
    1、CURL *curl_easy_init()
    此函数需要最先被调用，返回CRUL easy句柄；后续其他函数调用都要用到这个句柄。如果没有调用curl_global_init()，该函数自动调用，但是考虑到线程安全的问题，最好自己调用curl_global_init()。

 

    2、CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter)
    所有参数和选项设置都是通过这个函数完成的，它告诉libcurl怎样去进行传输。参数handle即为curl_easy_init()返回的句柄，后 面根据option的类型，设置相应的parameter值，该函数每次调用只能设置一个选项。具体的option讲解在这两篇博文中有较全面的介绍：
    http://blog.163.com/wangsen_315/blog/static/9461414200882384555217/ 
    http://blog.sina.com.cn/s/blog_4f9fc6e10100einf.html 
    这里只总结一下与下载有关的常用选项设置。
   
    CURLOPT_URL
    字符串类型，该选项设置要处理的URL地址，该选项是进行curl_easy_perform之前唯一必须要设置的选项。

CURLOPT_COOKIE
    字符串类型，设置http头中的cookie信息。
   
    CURLOPT_COOKIEFILE
    字符串类型，同CURLOPT_COOKIE，不过cookie信息从文件中读取。
   
    CURLOPT_FOLLOWLOCATION
    布尔值类型，该参数设置为非零值表示follow服务器返回的重定向信息。
   
    CURLOPT_POSTFIELDS
    字符串类型，提交http的post操作字符串数据。
   
   CURLOPT_TIMEOUT
    long数值类型，设置函数执行的最长时间，时间单位为s。
   
    CURLOPT_CONNECTTIMEOUT
    long数值类型，设置连接服务器最长时间，时间单位为s；当置为0时表示无限长。
   
   CURLOPT_MAX_RECV_SPEED_LARGE
    curl_off_t类型数据，指定下载过程中最大速度，单位bytes/s。
   
    CURLOPT_HEADERFUNCTION
    函数指针类型，该选项设置一个处理接收到的header数据的回调函数，函数原型为：
    size_t function( void *ptr, size_t size, size_t nmemb, void *stream)；
    其中，ptr指向接收到的header头数据，数据大小为size*nmemb，stream指向调用CURLOPT_WRITEHEADER选项设置的参数。该回调函数应返回实际处理的数据量大小，或者出错返回-1。

 

    CURLOPT_WRITEFUNCTION
    函数指针类型，该选项设置一个处理接收到的下载数据的回调函数，函数原型为：
    size_t function( void *ptr, size_t size, size_t nmemb, void *stream);
    其中，ptr指向接收到的数据，数据大小为size*nmemb，stream指向调用CURLOPT_WRITEDATA选项设置的参数。
    如果函数指针置为NULL，则会调用默认的函数，将数据写入到由CURLOPT_WRITEDATA指定的FILE*中。
   
    CURLOPT_HTTPHEADER
    curl_slist结构体类型，该选项自定义请求头信息。

 

CURLOPT_NOPROGRESS
    布尔值类型，设置该值为非零值关闭PHP为CRUL传输显示的进度条。
   

     CURLOPT_INFILESIZE

     当你上传一个文件到远程站点，这个选项告诉PHP你上传文件的大小。

 

    CURLOPT_VERBOSE

    如果你想CURL报告每一件意外的事情，设置这个选项为一个非零值。

 

    CURLOPT_HEADER

     如果你想把一个头包含在输出中，设置这个选项为一个非零值。

 

    CURLOPT_NOBODY

    如果你不想在输出中包含body部分，设置这个选项为一个非零值。

 

    CURLOPT_FAILONERROR

    如果你想让PHP在发生错误(HTTP代码返回大于等于300)时，不显示，设置这个选项为一人非零值。默认行为是返回一个正常页，忽略代码。

 

    CURLOPT_UPLOAD:如果你想让PHP为上传做准备，设置这个选项为一个非零值。

 

*CURLOPT_POST: 如果你想PHP去做一个正规的HTTPPOST，设置这个选项为一个非零值。这个POST是普通的application/x-www-from-urlencoded 类型，多数被HTML表单使用。

*CURLOPT_FTPLISTONLY:设置这个选项为非零值，PHP将列出FTP的目录名列表。

*CURLOPT_FTPAPPEND:设置这个选项为一个非零值，PHP将应用远程文件代替覆盖它。

*CURLOPT_NETRC: 设置这个选项为一个非零值，PHP将在你的 ~./netrc文件中查找你要建立连接的远程站点的用户名及密码。

*CURLOPT_FOLLOWLOCATION: 设置这个选项为一个非零值(象“Location:“)的头，服务器会把它当做HTTP头的一部分发送(注意这是递归的，PHP将发送形如“Location: “的头)。

*CURLOPT_PUT: 设置这个选项为一个非零值去用HTTP上传一个文件。要上传这个文件必须设置CURLOPT_INFILE和 CURLOPT_INFILESIZE选 项.*CURLOPT_MUTE:设置这个选项为一个非零值，PHP对于CURL函数将完全沉默。

*CURLOPT_LOW_SPEED_LIMIT:设置一个长整形数，控制传送多少字节。

*CURLOPT_LOW_SPEED_TIME:设置一个长整形数，控制多少秒传送CURLOPT_LOW_SPEED_LIMIT规定的字节数。

*CURLOPT_RESUME_FROM:传递一个包含字节偏移地址的长整形参数，(你想转移到的开始表单)。

*CURLOPT_SSLVERSION:传递一个包含SSL版本的长参数。默认PHP将被它自己努力的确定，在更多的安全中你必须手工设置。

*CURLOPT_TIMECONDITION:传递一个长参数，指定怎么处理CURLOPT_TIMEVALUE参数。你可以设置这个参数为TIMECOND_IFMODSINCE或 TIMECOND_ISUNMODSINCE。这仅用于HTTP。

*CURLOPT_TIMEVALUE:传递一个从1970-1-1开始到现在的秒数。这个时间将被CURLOPT_TIMEVALUE选项作为指定值使用，或被默认TIMECOND_IFMODSINCE使用。下列选项的值将被作为字符串：　

*CURLOPT_USERPWD:传递一个形如[username]:[password]风格的字符串,作用PHP去连接。

*CURLOPT_PROXYUSERPWD: 传递一个形如[username]:[password]格式的字符串去连接HTTP代理。

*CURLOPT_RANGE:传递一个你想指定的范围。它应该是”X-Y”格式，X或Y是被除外的。HTTP传送同样支持几个间隔，用逗句来分隔(X-Y,N-M)。

*CURLOPT_POSTFIELDS: 传递一个作为HTTP“POST”操作的所有数据的字符串。

*CURLOPT_REFERER:在HTTP请求中包含一个”referer”头的字符串。

*CURLOPT_USERAGENT:在HTTP请求中包含一个”user-agent”头的字符串。

*CURLOPT_FTPPORT: 传递一个包含被ftp“POST”指令使用的IP地址。这个POST指令告诉远程服务器去连接我们指定的IP地址。这个字符串可以是一个IP地址，一个主机名，一个网络界面名(在UNIX下)，或是‘-’(使用系统默认IP地址)。

*CURLOPT_COOKIE: 传递一个包含HTTP cookie的头连接。

*CURLOPT_SSLCERT: 传递一个包含PEM格式证书的字符串。

*CURLOPT_SSLCERTPASSWD:传递一个包含使用CURLOPT_SSLCERT证书必需的密码。

 

*CURLOPT_COOKIEFILE:传递一个包含cookie数据的文件的名字的字符串。这个cookie文件可以是Netscape格式，或是堆存在文件中的HTTP风格的头。

 

*CURLOPT_CUSTOMREQUEST: 当进行HTTP请求时，传递一个字符被GET或HEAD使用。为进行DELETE或其它操作是有益的，更 Passa string to be used instead of GET or HEAD when doing an HTTPrequest. This is useful for doing or another, more obscure, HTTPrequest. 注 意:在确认你的服务器支持命令先不要去这样做。下列的选项要求一个文件描述(通过使用fopen()函数获得)：　

 

*CURLOPT_FILE:这个文件将是你放置传送的输出文件，默认是STDOUT.

*CURLOPT_INFILE: 这个文件是你传送过来的输入文件。

*CURLOPT_STDERR:这个文件写有错误而不是stderr。用来获取需要登录的页面的例子,当前做法是每次或许都登录一次,有需要的人再做改进了:)

    3、void curl_easy_reset(CURL *handle )
    重新初始化CURL句柄的选项设置。

 4、CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ... )
    查询CRUL会话的内部信息，具体说明请参考curl自带文档。
   
    5、void curl_easy_cleanup(CURL * handle )
    该函数与curl_easy_init函数成对出现，handle即为调用curl_easy_init返回的句柄。该函数在CURL会话结束退出时调用，之后handle无效。