audacity::network_manager::CurlHandleManager Class Reference

#include <CurlHandleManager.h>

Collaboration diagram for audacity::network_manager::CurlHandleManager:

Classes
struct	CachedHandle
class	Handle

Public Member Functions
	CurlHandleManager ()
	~CurlHandleManager ()
void	setProxy (std::string proxy)
Handle	getHandle (RequestVerb verb, const std::string &url)

Private Types
using	RequestClock = std::chrono::steady_clock
using	RequestTimePoint = RequestClock::time_point

Private Member Functions
std::string	getUserAgent () const
CURL *	getCurlHandleFromCache (RequestVerb verb, const std::string &url)
void	cacheHandle (Handle &handle)
void	cleanupHandlesCache ()

Static Private Member Functions
static std::string	GetSchemeAndDomain (const std::string &url)

Private Attributes
std::string	mProxy
std::string	mUserAgent
std::mutex	mHandleCacheLock
std::vector< CachedHandle >	mHandleCache

Static Private Attributes
static constexpr std::chrono::milliseconds	KEEP_ALIVE_IDLE { std::chrono::seconds (120) }
static constexpr std::chrono::milliseconds	KEEP_ALIVE_PROBE { std::chrono::seconds (60) }

Detailed Description

Definition at line 31 of file CurlHandleManager.h.

Member Typedef Documentation

RequestClock

using audacity::network_manager::CurlHandleManager::RequestClock = std::chrono::steady_clock

private

Definition at line 99 of file CurlHandleManager.h.

RequestTimePoint

using audacity::network_manager::CurlHandleManager::RequestTimePoint = RequestClock::time_point

private

Definition at line 100 of file CurlHandleManager.h.

Constructor & Destructor Documentation

CurlHandleManager()

audacity::network_manager::CurlHandleManager::CurlHandleManager

(

)

Definition at line 266 of file CurlHandleManager.cpp.

{
    std::ostringstream ss;
 
    ss << "Audacity/" << 
        AUDACITY_VERSION << "." << 
        AUDACITY_RELEASE << "." << 
        AUDACITY_REVISION << 
        " (";
 
    GetOSString (ss, wxPlatformInfo::Get ());
 
    ss << ")";
 
    mUserAgent = ss.str ();
 
    mProxy = gCurlConfig.Proxy;
}

References audacity::network_manager::anonymous_namespace{CurlHandleManager.cpp}::gCurlConfig, BasicUI::Get(), audacity::network_manager::anonymous_namespace{CurlHandleManager.cpp}::GetOSString(), mProxy, mUserAgent, and audacity::network_manager::anonymous_namespace{CurlHandleManager.cpp}::CurlConfig::Proxy.

Here is the call graph for this function:

~CurlHandleManager()

audacity::network_manager::CurlHandleManager::~CurlHandleManager

(

)

Definition at line 285 of file CurlHandleManager.cpp.

{
    std::lock_guard<std::mutex> lock (mHandleCacheLock);
 
    for (auto& cachedHandle : mHandleCache)
        curl_easy_cleanup (cachedHandle.Handle);
}

References mHandleCache, and mHandleCacheLock.

Member Function Documentation

cacheHandle()

void audacity::network_manager::CurlHandleManager::cacheHandle ( Handle &  handle )

private

Definition at line 349 of file CurlHandleManager.cpp.

{
    // Reset the state to the safe defaults
    handle.reset ();
 
    std::lock_guard<std::mutex> lock (mHandleCacheLock);
 
    cleanupHandlesCache ();
 
    mHandleCache.push_back ({
        handle.mVerb,
        GetSchemeAndDomain (handle.mUrl),
        handle.mHandle,
        RequestClock::now ()
    });
}

References cleanupHandlesCache(), GetSchemeAndDomain(), audacity::network_manager::CurlHandleManager::Handle::mHandle, mHandleCache, mHandleCacheLock, audacity::network_manager::CurlHandleManager::Handle::mUrl, audacity::network_manager::CurlHandleManager::Handle::mVerb, and audacity::network_manager::CurlHandleManager::Handle::reset().

Referenced by audacity::network_manager::CurlHandleManager::Handle::~Handle().

Here is the call graph for this function:

Here is the caller graph for this function:

cleanupHandlesCache()

void audacity::network_manager::CurlHandleManager::cleanupHandlesCache ( )

private

Definition at line 366 of file CurlHandleManager.cpp.

{
    const RequestTimePoint timePoint = RequestClock::now ();
 
    mHandleCache.erase (std::remove_if (mHandleCache.begin (), mHandleCache.end (), [timePoint](const CachedHandle& cachedHandle) {
        return (timePoint - cachedHandle.RequestTime) >= KEEP_ALIVE_IDLE;
    }), mHandleCache.end ());
}

References mHandleCache.

Referenced by cacheHandle(), and getCurlHandleFromCache().

Here is the caller graph for this function:

getCurlHandleFromCache()

CURL * audacity::network_manager::CurlHandleManager::getCurlHandleFromCache ( RequestVerb  verb, const std::string &  url  )

private

Definition at line 327 of file CurlHandleManager.cpp.

{
    std::lock_guard<std::mutex> lock (mHandleCacheLock);
 
    cleanupHandlesCache ();
 
    const std::string schemeAndDomain = GetSchemeAndDomain (url);
 
    auto it = std::find_if (mHandleCache.begin (), mHandleCache.end (), [verb, schemeAndDomain](const CachedHandle& handle) {
        return handle.Verb == verb && handle.SchemeAndDomain == schemeAndDomain;
    });
 
    if (it == mHandleCache.end ())
        return nullptr;
 
    CURL* handle = it->Handle;
 
    mHandleCache.erase (it);
 
    return handle;
}

References cleanupHandlesCache(), GetSchemeAndDomain(), audacity::network_manager::CurlHandleManager::CachedHandle::Handle, mHandleCache, and mHandleCacheLock.

Referenced by getHandle().

Here is the call graph for this function:

Here is the caller graph for this function:

getHandle()

CurlHandleManager::Handle audacity::network_manager::CurlHandleManager::getHandle	(	RequestVerb	verb,
		const std::string &	url
	)

Definition at line 298 of file CurlHandleManager.cpp.

{
    Handle handle (this, getCurlHandleFromCache (verb, url), verb, url);
 
    if (!mProxy.empty ())
    {
        handle.setOption (CURLOPT_PROXY, mProxy);
        // If we use proxy, checking the CRL will likely break the SSL proxying
        handle.setOption (CURLOPT_SSL_OPTIONS, CURLSSLOPT_NO_REVOKE);
    }
 
    handle.setOption (CURLOPT_TCP_KEEPALIVE, 1L);
 
    handle.setOption (CURLOPT_TCP_KEEPIDLE, 
        std::chrono::duration_cast<std::chrono::seconds> (KEEP_ALIVE_IDLE).count ()
    );
 
    handle.setOption (CURLOPT_TCP_KEEPINTVL, 
        std::chrono::duration_cast<std::chrono::seconds> (KEEP_ALIVE_PROBE).count ()
    );
 
    return handle;
}

References getCurlHandleFromCache(), KEEP_ALIVE_IDLE, KEEP_ALIVE_PROBE, mProxy, and audacity::network_manager::CurlHandleManager::Handle::setOption().

Referenced by audacity::network_manager::CurlResponse::perform().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSchemeAndDomain()

std::string audacity::network_manager::CurlHandleManager::GetSchemeAndDomain ( const std::string &  url )

staticprivate

Definition at line 375 of file CurlHandleManager.cpp.

{
    const size_t schemeEndPosition = url.find ("://");
 
    if (schemeEndPosition == std::string::npos) // Is url even valid?
        return url;
 
    const size_t domainStartPosition = schemeEndPosition + 3;
 
    const size_t slashLocation = url.find ('/', domainStartPosition);
 
    if (slashLocation == std::string::npos)
        return url;
 
    return url.substr (domainStartPosition, slashLocation - domainStartPosition);
}

References Tuple::detail::npos().

Referenced by cacheHandle(), and getCurlHandleFromCache().

Here is the call graph for this function:

Here is the caller graph for this function:

getUserAgent()

std::string audacity::network_manager::CurlHandleManager::getUserAgent ( ) const

private

Definition at line 322 of file CurlHandleManager.cpp.

{
    return mUserAgent;
}

References mUserAgent.

setProxy()

void audacity::network_manager::CurlHandleManager::setProxy

(

std::string

proxy

)

Definition at line 293 of file CurlHandleManager.cpp.

{
    mProxy = std::move (proxy);
}

References mProxy.

Member Data Documentation

KEEP_ALIVE_IDLE

constexpr std::chrono::milliseconds audacity::network_manager::CurlHandleManager::KEEP_ALIVE_IDLE { std::chrono::seconds (120) }

staticconstexprprivate

Definition at line 102 of file CurlHandleManager.h.

Referenced by getHandle().

KEEP_ALIVE_PROBE

constexpr std::chrono::milliseconds audacity::network_manager::CurlHandleManager::KEEP_ALIVE_PROBE { std::chrono::seconds (60) }

staticconstexprprivate

Definition at line 103 of file CurlHandleManager.h.

Referenced by getHandle().

mHandleCache

std::vector<CachedHandle> audacity::network_manager::CurlHandleManager::mHandleCache

private

Definition at line 128 of file CurlHandleManager.h.

Referenced by cacheHandle(), cleanupHandlesCache(), getCurlHandleFromCache(), and ~CurlHandleManager().

mHandleCacheLock

std::mutex audacity::network_manager::CurlHandleManager::mHandleCacheLock

private

Definition at line 127 of file CurlHandleManager.h.

Referenced by cacheHandle(), getCurlHandleFromCache(), and ~CurlHandleManager().

mProxy

std::string audacity::network_manager::CurlHandleManager::mProxy

private

Definition at line 124 of file CurlHandleManager.h.

Referenced by CurlHandleManager(), getHandle(), and setProxy().

mUserAgent

std::string audacity::network_manager::CurlHandleManager::mUserAgent

private

Definition at line 125 of file CurlHandleManager.h.

Referenced by CurlHandleManager(), and getUserAgent().

---

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

• CurlHandleManager.h
• CurlHandleManager.cpp