audacity::network_manager::HeadersList Class Reference

#include <HeadersList.h>

Collaboration diagram for audacity::network_manager::HeadersList:

Public Types
using	HeadersIterator = HeadersStorageType::iterator
using	HeadersConstIterator = HeadersStorageType::const_iterator

Public Member Functions
void	setHeader (const Header &header)
void	setHeader (const std::string &headerName, std::string headerValue)
void	addHeader (Header header)
void	addHeader (std::string headerName, std::string headerValue)
bool	hasHeader (const std::string &headerName) const noexcept
std::string	getHeaderValue (const std::string &headerName) const
const Header *	getHeader (size_t idx) const noexcept
const Header *	getHeader (const std::string &name) const noexcept
size_t	getHeadersCount () const noexcept
HeadersIterator	begin () noexcept
HeadersIterator	end () noexcept
HeadersConstIterator	begin () const noexcept
HeadersConstIterator	end () const noexcept

Private Types
using	HeadersStorageType = std::vector< Header >

Private Member Functions
Header *	getHeader (size_t idx) noexcept
Header *	getHeader (const std::string &headerName) noexcept

Private Attributes
HeadersStorageType	mHeaders

Detailed Description

Definition at line 62 of file HeadersList.h.

Member Typedef Documentation

HeadersConstIterator

using audacity::network_manager::HeadersList::HeadersConstIterator = HeadersStorageType::const_iterator

Definition at line 67 of file HeadersList.h.

HeadersIterator

using audacity::network_manager::HeadersList::HeadersIterator = HeadersStorageType::iterator

Definition at line 66 of file HeadersList.h.

HeadersStorageType

using audacity::network_manager::HeadersList::HeadersStorageType = std::vector<Header>

private

Definition at line 64 of file HeadersList.h.

Member Function Documentation

addHeader() [1/2]

void HeadersList::addHeader

(

Header

header

)

Definition at line 107 of file HeadersList.cpp.

{
    addHeader (std::move (header.Name), std::move (header.Value));
}

References addHeader(), audacity::network_manager::Header::Name, and audacity::network_manager::Header::Value.

Referenced by addHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

addHeader() [2/2]

void HeadersList::addHeader	(	std::string	headerName,
		std::string	headerValue
	)

Definition at line 112 of file HeadersList.cpp.

{
    mHeaders.push_back ({ std::move (headerName), std::move (headerValue) });
}

References mHeaders.

begin() [1/2]

HeadersList::HeadersConstIterator HeadersList::begin ( ) const

noexcept

Definition at line 157 of file HeadersList.cpp.

{
    return mHeaders.begin ();
}

References mHeaders.

begin() [2/2]

HeadersList::HeadersIterator HeadersList::begin ( )

noexcept

Definition at line 147 of file HeadersList.cpp.

{
    return mHeaders.begin ();
}

References mHeaders.

end() [1/2]

HeadersList::HeadersConstIterator HeadersList::end ( ) const

noexcept

Definition at line 162 of file HeadersList.cpp.

{
    return mHeaders.end ();
}

References mHeaders.

end() [2/2]

HeadersList::HeadersIterator HeadersList::end ( )

noexcept

Definition at line 152 of file HeadersList.cpp.

{
    return mHeaders.end ();
}

References mHeaders.

getHeader() [1/4]

Header * HeadersList::getHeader ( const std::string &  headerName )

privatenoexcept

Definition at line 175 of file HeadersList.cpp.

{
    for (Header& header : mHeaders)
    {
        if (header.hasSameName (headerName))
            return &header;
    }
 
    return nullptr;
}

getHeader() [2/4]

const Header * HeadersList::getHeader ( const std::string &  name ) const

noexcept

Definition at line 137 of file HeadersList.cpp.

{
    return const_cast<HeadersList*>(this)->getHeader (name);
}

References name.

getHeader() [3/4]

const Header * HeadersList::getHeader ( size_t  idx ) const

noexcept

Definition at line 132 of file HeadersList.cpp.

{
    return const_cast<HeadersList*>(this)->getHeader (idx);
}

Referenced by getHeaderValue(), and setHeader().

Here is the caller graph for this function:

getHeader() [4/4]

Header * HeadersList::getHeader ( size_t  idx )

privatenoexcept

Definition at line 167 of file HeadersList.cpp.

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

getHeadersCount()

size_t HeadersList::getHeadersCount ( ) const

noexcept

Definition at line 142 of file HeadersList.cpp.

{
    return mHeaders.size ();
}

References mHeaders.

getHeaderValue()

std::string HeadersList::getHeaderValue

(

const std::string &

headerName

)

const

Definition at line 122 of file HeadersList.cpp.

{
    const Header* header = getHeader (headerName);
 
    if (header != nullptr)
        return header->Value;
 
    return {};
}

References getHeader(), and audacity::network_manager::Header::Value.

Referenced by audacity::network_manager::CurlResponse::getHeader(), and audacity::network_manager::Request::getHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

hasHeader()

bool HeadersList::hasHeader ( const std::string &  headerName ) const

noexcept

Definition at line 117 of file HeadersList.cpp.

{
    return getHeader (headerName) != nullptr;
}

setHeader() [1/2]

void HeadersList::setHeader

(

const Header &

header

)

Definition at line 92 of file HeadersList.cpp.

{
    setHeader (header.Name, header.Value);
}

References audacity::network_manager::Header::Name, setHeader(), and audacity::network_manager::Header::Value.

Referenced by setHeader(), audacity::network_manager::MultipartData::Part::SetHeader(), and audacity::network_manager::Request::setHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

setHeader() [2/2]

void HeadersList::setHeader	(	const std::string &	headerName,
		std::string	headerValue
	)

Definition at line 97 of file HeadersList.cpp.

{
    Header* item = getHeader (headerName);
 
    if (item != nullptr)
        item->Value = std::move (headerValue);
    else
        mHeaders.push_back ({ headerName, std::move (headerValue) });
}

References getHeader(), mHeaders, and audacity::network_manager::Header::Value.

Here is the call graph for this function:

Member Data Documentation

mHeaders

HeadersStorageType audacity::network_manager::HeadersList::mHeaders

private

Definition at line 93 of file HeadersList.h.

Referenced by addHeader(), begin(), end(), getHeadersCount(), and setHeader().

---

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

• HeadersList.h
• HeadersList.cpp