KICAD_CURL Class Reference

Simple wrapper class to call curl_global_init and curl_global_cleanup for KiCad. More...

#include <kicad_curl.h>

Static Public Member Functions
static void	Init ()
	Call curl_global_init for the application. More...
static void	Cleanup ()
	Call curl_global_cleanup for the application. More...
static const char *	GetVersion ()
	Wrapper for curl_version(). More...
static std::string	GetSimpleVersion ()
	Report back curl version only and SSL library support. More...

Friends
class	KICAD_CURL_EASY

Detailed Description

Simple wrapper class to call curl_global_init and curl_global_cleanup for KiCad.

Definition at line 63 of file kicad_curl.h.

Member Function Documentation

Cleanup()

void KICAD_CURL::Cleanup ( )

static

Call curl_global_cleanup for the application.

It must be used only after curl_global_init was called.

Definition at line 72 of file kicad_curl.cpp.

{
 /*

 Calling lock_guard() from a static destructor will typically be bad, since the
 s_lock may already have been statically destroyed itself leading to a boost
 exception. (Remember C++ does not provide certain sequencing of static
 destructor invocation.)

 To prevent this we test s_initialized twice, which ensures that the lock_guard
 is only instantiated on the first call, which should be from
 PGM_BASE::destroy() which is first called earlier than static destruction.
 Then when called again from the actual PGM_BASE::~PGM_BASE() function,
 lock_guard will not be instantiated because s_initialized will be false.

 */

 if( s_initialized )
 {
 std::lock_guard<std::mutex> lock( s_lock );

 if( s_initialized )
 {
 curl_global_cleanup();

 atexit( &at_terminate );

 s_initialized = false;
 }
 }
}

References at_terminate(), s_initialized, and s_lock.

Referenced by at_terminate().

GetSimpleVersion()

std::string KICAD_CURL::GetSimpleVersion ( )

static

Report back curl version only and SSL library support.

Returns

Generated version string.

Definition at line 105 of file kicad_curl.cpp.

{
 if( !s_initialized )
 Init();

 curl_version_info_data* info = curl_version_info( CURLVERSION_NOW );

 std::string res;

 if( info->version )
 {
 res += "libcurl version: " + std::string( info->version );
 }

 res += " (";

 if( info->features & CURL_VERSION_SSL )
 {
 res += "with SSL - ";
 res += std::string( info->ssl_version );
 }
 else
 {
 res += "without SSL";
 }
 res += ")";

 return res;
}

References info, Init(), and s_initialized.

GetVersion()

static const char* KICAD_CURL::GetVersion ( )

inlinestatic

Wrapper for curl_version().

Reports back a short string of loaded libraries.

Returns

String reported by libcurl and owned by it.

Exceptions

IO_ERROR

on failure, hopefully with helpful text in it.

Definition at line 87 of file kicad_curl.h.

 {
 return curl_version();
 }

Referenced by GetKicadCurlVersion().

Init()

void KICAD_CURL::Init ( )

static

Call curl_global_init for the application.

It must be used only once and before any curl functions that perform requests.

Returns

True if successful, false if CURL returned an error.

Exceptions

IO_ERROR

on failure, hopefully with helpful text in it.

Definition at line 50 of file kicad_curl.cpp.

{
 // We test s_initialized twice in an effort to avoid
 // unnecessarily locking s_lock. This understands that the common case
 // will not need to lock.
 if( !s_initialized )
 {
 std::lock_guard<std::mutex> lock( s_lock );

 if( !s_initialized )
 {
 if( curl_global_init( CURL_GLOBAL_ALL ) != CURLE_OK )
 {
 THROW_IO_ERROR( "curl_global_init() failed." );
 }

 s_initialized = true;
 }
 }
}

References s_initialized, s_lock, and THROW_IO_ERROR.

Referenced by GetSimpleVersion(), and KICAD_CURL_EASY::KICAD_CURL_EASY().

Friends And Related Function Documentation

KICAD_CURL_EASY

friend class KICAD_CURL_EASY

friend

Definition at line 101 of file kicad_curl.h.

---

The documentation for this class was generated from the following files:

• kicad_curl.h
• kicad_curl.cpp