zoukankan      html  css  js  c++  java
  • libcurl库(C++)快速使用

    ---恢复内容开始---

    libcurl是一个跨平台的网络协议库,支持http, https, ftp, gopher, telnet, dict, file, 和ldap 协议。libcurl同样支持HTTPS证书授权,HTTP POST, HTTP PUT, FTP 上传, HTTP基本表单上传,代理,cookies,和用户认证。
    在基于LibCurl的程序里,主要采用callback function (回调函数)的形式完成传输任务,用户在启动传输前设置好各类参数和回调函数,当满足条件时libcurl将调用用户的回调函数实现特定功能。
      libcurl主要提供了两种发送http请求的方式,分别是Easy interface方式和multi interface方式,前者是采用阻塞的方式发送单条数据,后者采用组合的方式可以一次性发送多条数据

    一、Easy interface

    libcurl的easy interface是最基本的用法,简要流程为:
    1、在主线程中调用curl_global_init(CURL_GLOBAL_ALL)初始化
    2、调用curl_easy_init获取一个句柄;
    3、调用curl_easy_setopt函数设置此次传输的一些基本参数,如url地址、http头、cookie信息、发送超时时间等,其中,CURLOPT_URL是必设的选项;
    4、设置完成后,调用curl_easy_perform函数发送数据;
    5、数据发送完毕后,调用curl_easy_cleanup清空句柄;
    6、调用curl_global_cleanup()做清理工作。

    在整过过程中设置curl_easy_setopt()参数是最关键的,几乎所有的libcurl程序都要使用它。

    二、一些基本的函数
     
          1.CURLcode curl_global_init(long flags);
    描述:
    这个函数只能用一次。(其实在调用curl_global_cleanup 函数后仍然可再用)
    如果这个函数在curl_easy_init函数调用时还没调用,它讲由libcurl库自动调用,所以多线程下最好主动调用该函数以防止在线程中curl_easy_init时多次调用。
    注意:虽然libcurl是线程安全的,但curl_global_init是不能保证线程安全的,所以不要在每个线程中都调用curl_global_init,应该将该函数的调用放在主线程中。
    参数:flags
    CURL_GLOBAL_ALL                      //初始化所有的可能的调用。
    CURL_GLOBAL_SSL                      //初始化支持 安全套接字层。
    CURL_GLOBAL_WIN32            //初始化win32套接字库。
    CURL_GLOBAL_NOTHING         //没有额外的初始化
     
    2 void curl_global_cleanup(void);
    描述:在结束libcurl使用的时候,用来对curl_global_init做的工作清理。类似于close的函数。
    注意:虽然libcurl是线程安全的,但curl_global_cleanup是不能保证线程安全的,所以不要在每个线程中都调用curl_global_init,应该将该函数的调用放在主线程中。

    3 char *curl_version( );
    描述: 打印当前libcurl库的版本。

    4 CURL *curl_easy_init( );
    描述:
    curl_easy_init用来初始化一个CURL的指针(有些像返回FILE类型的指针一样). 相应的在调用结束时要用curl_easy_cleanup函数清理.
    一般curl_easy_init意味着一个会话的开始. 它会返回一个easy_handle(CURL*对象), 一般都用在easy系列的函数中.

    5 void curl_easy_cleanup(CURL *handle);
    描述:
       这个调用用来结束一个会话.与curl_easy_init配合着用. 
    参数:
    CURL类型的指针.

    6 CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter);
    描述: 这个函数最重要了.几乎所有的curl 程序都要频繁的使用它.它告诉curl库.程序将有如何的行为. 比如要查看一个网页的html代码等.(这个函数有些像ioctl函数)参数:

    1 CURL类型的指针
    2 各种CURLoption类型的选项.(都在curl.h库里有定义,man 也可以查看到)
    3 parameter 这个参数 既可以是个函数的指针,也可以是某个对象的指针,也可以是个long型的变量.它用什么这取决于第二个参数.
    CURLoption 这个参数的取值很多.具体的可以查看man手册.

    7 CURLcode curl_easy_perform(CURL *handle);
    描述:这个函数在初始化CURL类型的指针 以及curl_easy_setopt完成后调用. 就像字面的意思所说perform就像是个舞台.让我们设置的option 运作起来.
    参数:
    CURL类型的指针.
     
     
     
    三、 curl_easy_setopt函数部分选项介绍
     
    该函数是curl中非常重要的函数,curl所有设置都是在该函数中完成的,该函数的设置选项众多,注意本节的阐述的只是部分常见选项。
     
    1.     CURLOPT_URL 
    设置访问URL

    2.       CURLOPT_WRITEFUNCTION,CURLOPT_WRITEDATA
    static size_t OnWriteFile(void* buffer, size_t size, size_t nmemb, void* lpVoid)
    {
        FILE* stream = (FILE *)lpVoid;
        if (nullptr == stream || nullptr == buffer)
        {
            return -1;
        }
        size_t nWrite = fwrite(buffer, size, nmemb, stream);
        return nWrite;
    }
    
    curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, OnWriteFile);     //写入数据的回调
    curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)m_file);  
    回调函数原型为:size_t function( void *ptr, size_t size, size_t nmemb, void *stream); 函数将在libcurl接收到数据后被调用,因此函数多做数据保存的功能,如处理下载文件。CURLOPT_WRITEDATA 用于表明CURLOPT_WRITEFUNCTION函数中的stream指针的来源。
    如果你没有通过CURLOPT_WRITEFUNCTION属性给easy handle设置回调函数,libcurl会提供一个默认的回调函数,它只是简单的将接收到的数据打印到标准输出。你也可以通过 CURLOPT_WRITEDATA属性给默认回调函数传递一个已经打开的文件指针,用于将数据输出到文件里。

    3.      CURLOPT_HEADERFUNCTION,CURLOPT_HEADERDATA
    static size_t OnHeader(void* buffer, size_t size, size_t nmemb, void* lpVoid)
    {
        std::string* str = dynamic_cast<std::string*>((std::string *)lpVoid);
        if (nullptr == str || nullptr == buffer)
        {
            return -1;
        }
        
        char* pData = (char*)buffer;
        str->append(pData, size * nmemb);      //str后面追加pData
        return nmemb;
    }
    
    curl_easy_setopt(curl, CURLOPT_HEADERFUNCTION, OnHeader);                   //写入接受头的回调
    std::string header;
    curl_easy_setopt(curl, CURLOPT_HEADERDATA, &header);  
    回调函数原型为 size_t function( void *ptr, size_t size,size_t nmemb, void *stream); libcurl一旦接收到http 头部数据后将调用该函数。CURLOPT_WRITEDATA 传递指针给libcurl,该指针表明CURLOPT_HEADERFUNCTION 函数的stream指针的来源。

    4.       CURLOPT_READFUNCTION CURLOPT_READDATA  curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, OnWriteFile); //写入数据的回调  curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)m_file); //数据指针传递给写回调
     
    static size_t OnWriteFile(void* buffer, size_t size, size_t nmemb, void* lpVoid)
    {
    FILE* stream = (FILE *)lpVoid;
    if (nullptr == stream || nullptr == buffer)
    {
    return -1;
    }
    size_t nWrite = fwrite(buffer, size, nmemb, stream);
    return nWrite;
    }
    libCurl需要读取数据传递给远程主机时将调用CURLOPT_READFUNCTION指定的函数,函数原型是:size_t function(void *ptr, size_t size, size_t nmemb,void *stream). CURLOPT_READDATA 表明CURLOPT_READFUNCTION函数原型中的stream指针来源。

    5.       CURLOPT_NOPROGRESS,CURLOPT_PROGRESSFUNCTION,CURLOPT_PROGRESSDATA
     static size_t OnProgress(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow) {
        curl_http_downloader* dd = (curl_http_downloader*)clientp;
    
        if (dd->m_progress) {
            dd->m_progress(dltotal,dlnow,ultotal,ulnow);
        }
        return 0;
    };
    curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0); //关闭进度表
    curl_easy_setopt(curl, CURLOPT_PROGRESSFUNCTION, OnProgress); //过时的回调进度表
    curl_easy_setopt(curl, CURLOPT_RESUME_FROM, LocalFilelen);
    跟数据传输进度相关的参数。CURLOPT_PROGRESSFUNCTION 指定的函数正常情况下每秒被libcurl调用一次,为了使CURLOPT_PROGRESSFUNCTION被调用,CURLOPT_NOPROGRESS必须被设置为false,CURLOPT_PROGRESSDATA指定的参数将作为CURLOPT_PROGRESSFUNCTION指定函数的第一个参数

    6.       CURLOPT_TIMEOUT,CURLOPT_CONNECTIONTIMEOUT:
    CURLOPT_TIMEOUT 由于设置传输时间,CURLOPT_CONNECTIONTIMEOUT 设置连接等待时间

    7.       CURLOPT_FOLLOWLOCATION
    设置重定位URL

    8.       CURLOPT_RANGE: CURLOPT_RESUME_FROM:
    断点续传相关设置。CURLOPT_RANGE 指定char *参数传递给libcurl,用于指明http域的RANGE头域,例如:
    表示头500个字节:bytes=0-499
    表示第二个500字节:bytes=500-999
    表示最后500个字节:bytes=-500
    表示500字节以后的范围:bytes=500-
    第一个和最后一个字节:bytes=0-0,-1
    同时指定几个范围:bytes=500-600,601-999
    CURLOPT_RESUME_FROM 传递一个long参数给libcurl,指定你希望开始传递的 偏移量。

    四、 curl_easy_perform 函数说明(error 状态码)
    该函数是完成curl_easy_setopt指定的所有选项,本节重点介绍curl_easy_perform的返回值。返回0意味一切ok,非0代表错误发生。主要错误码说明:
    1.    CURLE_OK 
        任务完成一切都好
    2     CURLE_UNSUPPORTED_PROTOCOL
        不支持的协议,由URL的头部指定
    3     CURLE_COULDNT_CONNECT
        不能连接到remote 主机或者代理
    4     CURLE_REMOTE_ACCESS_DENIED
        访问被拒绝
    5     CURLE_HTTP_RETURNED_ERROR
        Http返回错误
    6     CURLE_READ_ERROR
    读本地文件错误
    要获取详细的错误描述字符串,可以通过const char *curl_easy_strerror(CURLcode errornum ) 这个函数取得.
     

    ---恢复内容结束---

  • 相关阅读:
    dotnet 网络编程 tcp
    sql_index 索引测试
    精美诗文
    mssql常用语句,平时用来学习sql的
    dotnet 线程同步
    DotNet 序列化
    2、董事长千金诱拐事件
    十三、动态创建元素
    1、云霄飞车杀人事件
    十二、内容过滤器,可见性过滤器,属性过滤器,子元素过滤器,表单类别过滤器,表单属性过滤器
  • 原文地址:https://www.cnblogs.com/lizhanzhe/p/10868074.html
Copyright © 2011-2022 走看看