KiCad PCB EDA Suite
Classes | Typedefs
kicad_curl_easy.h File Reference
#include <functional>
#include <memory>
#include <ostream>
#include <string>

Go to the source code of this file.

Classes

class  KICAD_CURL_EASY
 

Typedefs

typedef void CURL
 
typedef std::function< int(size_t, size_t, size_t, size_t)> TRANSFER_CALLBACK
 Wrapper interface around the curl_easy API/. More...
 

Typedef Documentation

◆ CURL

typedef void CURL

Definition at line 41 of file kicad_curl_easy.h.

◆ TRANSFER_CALLBACK

typedef std::function<int( size_t, size_t, size_t, size_t )> TRANSFER_CALLBACK

Wrapper interface around the curl_easy API/.

Handling of using the curl_easy API to make a request and save the response to a memory buffer

Here is a small example usage:

KICAD_CURL_EASY curl;
curl.SetURL( "http://github.com" );
curl.SetUserAgent( <http-client-identifier> );
curl.SetHeader( "Accept", "application/json" );
curl.Perform();
KICAD_CURL_EASY
Definition: kicad_curl_easy.h:67
KICAD_CURL_EASY::Perform
int Perform()
Equivalent to curl_easy_perform.
Definition: kicad_curl_easy.cpp:170
KICAD_CURL_EASY::SetUserAgent
bool SetUserAgent(const std::string &aAgent)
Set the request user agent.
Definition: kicad_curl_easy.cpp:202
KICAD_CURL_EASY::SetHeader
void SetHeader(const std::string &aName, const std::string &aValue)
Set an arbitrary header for the HTTP(s) request.
Definition: kicad_curl_easy.cpp:182
KICAD_CURL_EASY::SetURL
bool SetURL(const std::string &aURL)
Set the request URL.
Definition: kicad_curl_easy.cpp:211

Definition at line 62 of file kicad_curl_easy.h.