audacity::network_manager::CookiesList Class Reference

#include <CookiesList.h>

Collaboration diagram for audacity::network_manager::CookiesList:

Public Types
using	CookiesIterator = CookiesStorageType::iterator
using	CookiesConstIterator = CookiesStorageType::const_iterator

Public Member Functions
void	setCookie (const Cookie &cookie)
void	setCookie (const std::string &cookieName, std::string cookieValue)
void	addCookie (Cookie cookie)
void	addCookie (std::string cookieName, std::string cookieValue)
bool	hasCookie (const std::string &cookieName) const noexcept
std::string	getCookieValue (const std::string &cookieName) const
const Cookie *	getCookie (size_t idx) const noexcept
const Cookie *	getCookie (const std::string &name) const noexcept
size_t	getCookiesCount () const noexcept
std::string	getCookiesString () const
CookiesIterator	begin () noexcept
CookiesIterator	end () noexcept
CookiesConstIterator	begin () const noexcept
CookiesConstIterator	end () const noexcept

Private Types
using	CookiesStorageType = std::vector< Cookie >

Private Member Functions
Cookie *	getCookie (size_t idx) noexcept
Cookie *	getCookie (const std::string &cookieName) noexcept

Private Attributes
CookiesStorageType	mCookies

Detailed Description

Definition at line 41 of file CookiesList.h.

Member Typedef Documentation

CookiesConstIterator

using audacity::network_manager::CookiesList::CookiesConstIterator = CookiesStorageType::const_iterator

Definition at line 46 of file CookiesList.h.

CookiesIterator

using audacity::network_manager::CookiesList::CookiesIterator = CookiesStorageType::iterator

Definition at line 45 of file CookiesList.h.

CookiesStorageType

using audacity::network_manager::CookiesList::CookiesStorageType = std::vector<Cookie>

private

Definition at line 43 of file CookiesList.h.

Member Function Documentation

addCookie() [1/2]

void CookiesList::addCookie

(

Cookie

cookie

)

Definition at line 120 of file CookiesList.cpp.

{
    addCookie (std::move (cookie.Name), std::move (cookie.Value));
}

References addCookie(), audacity::network_manager::Cookie::Name, and audacity::network_manager::Cookie::Value.

Referenced by addCookie().

Here is the call graph for this function:

Here is the caller graph for this function:

addCookie() [2/2]

void CookiesList::addCookie	(	std::string	cookieName,
		std::string	cookieValue
	)

Definition at line 125 of file CookiesList.cpp.

{
    mCookies.push_back ({ std::move (cookieName), std::move (cookieValue) });
}

References mCookies.

begin() [1/2]

CookiesList::CookiesConstIterator CookiesList::begin ( ) const

noexcept

Definition at line 185 of file CookiesList.cpp.

{
    return mCookies.begin ();
}

References mCookies.

begin() [2/2]

CookiesList::CookiesIterator CookiesList::begin ( )

noexcept

Definition at line 175 of file CookiesList.cpp.

{
    return mCookies.begin ();
}

References mCookies.

end() [1/2]

CookiesList::CookiesConstIterator CookiesList::end ( ) const

noexcept

Definition at line 190 of file CookiesList.cpp.

{
    return mCookies.end ();
}

References mCookies.

end() [2/2]

CookiesList::CookiesIterator CookiesList::end ( )

noexcept

Definition at line 180 of file CookiesList.cpp.

{
    return mCookies.end ();
}

References mCookies.

getCookie() [1/4]

Cookie * CookiesList::getCookie ( const std::string &  cookieName )

privatenoexcept

Definition at line 203 of file CookiesList.cpp.

{
    for (Cookie& cookie : mCookies)
    {
        if (cookie.Name == cookieName)
            return &cookie;
    }
 
    return nullptr;
}

getCookie() [2/4]

const Cookie * CookiesList::getCookie ( const std::string &  name ) const

noexcept

Definition at line 150 of file CookiesList.cpp.

{
    return const_cast<CookiesList*>(this)->getCookie (name);
}

References name.

getCookie() [3/4]

const Cookie * CookiesList::getCookie ( size_t  idx ) const

noexcept

Definition at line 145 of file CookiesList.cpp.

{
    return const_cast<CookiesList*>(this)->getCookie(idx);
}

Referenced by getCookieValue(), and setCookie().

Here is the caller graph for this function:

getCookie() [4/4]

Cookie * CookiesList::getCookie ( size_t  idx )

privatenoexcept

Definition at line 195 of file CookiesList.cpp.

{
    if (idx < mCookies.size ())
        return &mCookies[idx];
 
    return nullptr;
}

getCookiesCount()

size_t CookiesList::getCookiesCount ( ) const

noexcept

Definition at line 155 of file CookiesList.cpp.

{
    return mCookies.size ();
}

References mCookies.

getCookiesString()

std::string CookiesList::getCookiesString

(

)

const

Definition at line 160 of file CookiesList.cpp.

{
    std::string result;
 
    for (const Cookie& cookie : mCookies)
    {
        if (!result.empty ())
            result.push_back (';');
 
        result += cookie.Name + "=" + cookie.Value;
    }
 
    return result;
}

References mCookies.

getCookieValue()

std::string CookiesList::getCookieValue

(

const std::string &

cookieName

)

const

Definition at line 135 of file CookiesList.cpp.

{
    const Cookie* item = getCookie (cookieName);
 
    if (item != nullptr)
        return item->Value;
 
    return {};
}

References getCookie(), and audacity::network_manager::Cookie::Value.

Referenced by audacity::network_manager::Request::getCookie().

Here is the call graph for this function:

Here is the caller graph for this function:

hasCookie()

bool CookiesList::hasCookie ( const std::string &  cookieName ) const

noexcept

Definition at line 130 of file CookiesList.cpp.

{
    return getCookie (cookieName) != nullptr;
}

setCookie() [1/2]

void CookiesList::setCookie

(

const Cookie &

cookie

)

Definition at line 105 of file CookiesList.cpp.

{
    setCookie (cookie.Name, cookie.Value);
}

References audacity::network_manager::Cookie::Name, setCookie(), and audacity::network_manager::Cookie::Value.

Referenced by audacity::network_manager::Request::appendCookies(), setCookie(), and audacity::network_manager::Request::setCookie().

Here is the call graph for this function:

Here is the caller graph for this function:

setCookie() [2/2]

void CookiesList::setCookie	(	const std::string &	cookieName,
		std::string	cookieValue
	)

Definition at line 110 of file CookiesList.cpp.

{
    Cookie* item = getCookie (cookieName);
 
    if (item != nullptr)
        item->Value = std::move (cookieValue);
    else
        mCookies.push_back ({ cookieName, std::move (cookieValue) });
}

References getCookie(), mCookies, and audacity::network_manager::Cookie::Value.

Here is the call graph for this function:

Member Data Documentation

mCookies

CookiesStorageType audacity::network_manager::CookiesList::mCookies

private

Definition at line 74 of file CookiesList.h.

Referenced by addCookie(), begin(), end(), getCookiesCount(), getCookiesString(), and setCookie().

---

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

• CookiesList.h
• CookiesList.cpp