cpp_restapi::BaseConnection Class Reference

base class with common parts for backend specific implementations More...

#include <base_connection.hpp>

Inheritance diagram for cpp_restapi::BaseConnection:

Public Member Functions
	BaseConnection (const std::string &address, const std::map< std::string, std::string > &headerEntries)
std::string	get (const std::string &) final
	perform a request to api
const std::string &	url () const final
	return API url
virtual std::pair< std::string, std::string >	fetchPage (const std::string &request)=0
Public Member Functions inherited from cpp_restapi::IConnection
virtual	~IConnection ()=default

Protected Member Functions
const std::map< std::string, std::string > &	getHeaderEntries () const
const std::string &	address () const

Detailed Description

base class with common parts for backend specific implementations

Constructor & Destructor Documentation

BaseConnection()

cpp_restapi::BaseConnection::BaseConnection ( const std::string & address, const std::map< std::string, std::string > & headerEntries )

explicit

Member Function Documentation

address()

const std::string & cpp_restapi::BaseConnection::address ( ) const

protected

fetchPage()

virtual std::pair< std::string, std::string > cpp_restapi::BaseConnection::fetchPage ( const std::string & request )

pure virtual

Implemented in cpp_restapi::CppHttplibBackend::Connection, cpp_restapi::CurlBackend::Connection, and cpp_restapi::QtBackend::Connection.

get()

std::string cpp_restapi::BaseConnection::get ( const std::string & request )

finalvirtual

perform a request to api

Parameters

request

api request. For example "users/SomeUserName/repos"

Returns

api response in json format

Implements cpp_restapi::IConnection.

getHeaderEntries()

const std::map< std::string, std::string > & cpp_restapi::BaseConnection::getHeaderEntries ( ) const

protected

url()

const std::string & cpp_restapi::BaseConnection::url ( ) const

finalvirtual

return API url

Implements cpp_restapi::IConnection.

---

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

• include/cpp_restapi/base_connection.hpp