httplib::ClientImpl Class Reference

#include <httplib.h>

Collaboration diagram for httplib::ClientImpl:

Classes
struct	Socket

Public Member Functions
	ClientImpl (const std::string &host)
	ClientImpl (const std::string &host, int port)
	ClientImpl (const std::string &host, int port, const std::string &client_cert_path, const std::string &client_key_path)
virtual	~ClientImpl ()
virtual bool	is_valid () const
Result	Get (const char *path)
Result	Get (const char *path, const Headers &headers)
Result	Get (const char *path, Progress progress)
Result	Get (const char *path, const Headers &headers, Progress progress)
Result	Get (const char *path, ContentReceiver content_receiver)
Result	Get (const char *path, const Headers &headers, ContentReceiver content_receiver)
Result	Get (const char *path, ContentReceiver content_receiver, Progress progress)
Result	Get (const char *path, const Headers &headers, ContentReceiver content_receiver, Progress progress)
Result	Get (const char *path, ResponseHandler response_handler, ContentReceiver content_receiver)
Result	Get (const char *path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver)
Result	Get (const char *path, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress)
Result	Get (const char *path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress)
Result	Get (const char *path, const Params &params, const Headers &headers, Progress progress=nullptr)
Result	Get (const char *path, const Params &params, const Headers &headers, ContentReceiver content_receiver, Progress progress=nullptr)
Result	Get (const char *path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress=nullptr)
Result	Head (const char *path)
Result	Head (const char *path, const Headers &headers)
Result	Post (const char *path)
Result	Post (const char *path, const char *body, size_t content_length, const char *content_type)
Result	Post (const char *path, const Headers &headers, const char *body, size_t content_length, const char *content_type)
Result	Post (const char *path, const std::string &body, const char *content_type)
Result	Post (const char *path, const Headers &headers, const std::string &body, const char *content_type)
Result	Post (const char *path, size_t content_length, ContentProvider content_provider, const char *content_type)
Result	Post (const char *path, ContentProviderWithoutLength content_provider, const char *content_type)
Result	Post (const char *path, const Headers &headers, size_t content_length, ContentProvider content_provider, const char *content_type)
Result	Post (const char *path, const Headers &headers, ContentProviderWithoutLength content_provider, const char *content_type)
Result	Post (const char *path, const Params &params)
Result	Post (const char *path, const Headers &headers, const Params &params)
Result	Post (const char *path, const MultipartFormDataItems &items)
Result	Post (const char *path, const Headers &headers, const MultipartFormDataItems &items)
Result	Post (const char *path, const Headers &headers, const MultipartFormDataItems &items, const std::string &boundary)
Result	Put (const char *path)
Result	Put (const char *path, const char *body, size_t content_length, const char *content_type)
Result	Put (const char *path, const Headers &headers, const char *body, size_t content_length, const char *content_type)
Result	Put (const char *path, const std::string &body, const char *content_type)
Result	Put (const char *path, const Headers &headers, const std::string &body, const char *content_type)
Result	Put (const char *path, size_t content_length, ContentProvider content_provider, const char *content_type)
Result	Put (const char *path, ContentProviderWithoutLength content_provider, const char *content_type)
Result	Put (const char *path, const Headers &headers, size_t content_length, ContentProvider content_provider, const char *content_type)
Result	Put (const char *path, const Headers &headers, ContentProviderWithoutLength content_provider, const char *content_type)
Result	Put (const char *path, const Params &params)
Result	Put (const char *path, const Headers &headers, const Params &params)
Result	Patch (const char *path)
Result	Patch (const char *path, const char *body, size_t content_length, const char *content_type)
Result	Patch (const char *path, const Headers &headers, const char *body, size_t content_length, const char *content_type)
Result	Patch (const char *path, const std::string &body, const char *content_type)
Result	Patch (const char *path, const Headers &headers, const std::string &body, const char *content_type)
Result	Patch (const char *path, size_t content_length, ContentProvider content_provider, const char *content_type)
Result	Patch (const char *path, ContentProviderWithoutLength content_provider, const char *content_type)
Result	Patch (const char *path, const Headers &headers, size_t content_length, ContentProvider content_provider, const char *content_type)
Result	Patch (const char *path, const Headers &headers, ContentProviderWithoutLength content_provider, const char *content_type)
Result	Delete (const char *path)
Result	Delete (const char *path, const Headers &headers)
Result	Delete (const char *path, const char *body, size_t content_length, const char *content_type)
Result	Delete (const char *path, const Headers &headers, const char *body, size_t content_length, const char *content_type)
Result	Delete (const char *path, const std::string &body, const char *content_type)
Result	Delete (const char *path, const Headers &headers, const std::string &body, const char *content_type)
Result	Options (const char *path)
Result	Options (const char *path, const Headers &headers)
bool	send (Request &req, Response &res, Error &error)
Result	send (const Request &req)
size_t	is_socket_open () const
void	stop ()
void	set_default_headers (Headers headers)
void	set_address_family (int family)
void	set_tcp_nodelay (bool on)
void	set_socket_options (SocketOptions socket_options)
void	set_connection_timeout (time_t sec, time_t usec=0)
template<class Rep , class Period >
void	set_connection_timeout (const std::chrono::duration< Rep, Period > &duration)
void	set_read_timeout (time_t sec, time_t usec=0)
template<class Rep , class Period >
void	set_read_timeout (const std::chrono::duration< Rep, Period > &duration)
void	set_write_timeout (time_t sec, time_t usec=0)
template<class Rep , class Period >
void	set_write_timeout (const std::chrono::duration< Rep, Period > &duration)
void	set_basic_auth (const char *username, const char *password)
void	set_bearer_token_auth (const char *token)
void	set_keep_alive (bool on)
void	set_follow_location (bool on)
void	set_compress (bool on)
void	set_decompress (bool on)
void	set_interface (const char *intf)
void	set_proxy (const char *host, int port)
void	set_proxy_basic_auth (const char *username, const char *password)
void	set_proxy_bearer_token_auth (const char *token)
void	set_logger (Logger logger)

Protected Member Functions
Result	send_ (Request &&req)
virtual bool	create_and_connect_socket (Socket &socket, Error &error)
virtual void	shutdown_ssl (Socket &socket, bool shutdown_gracefully)
void	shutdown_socket (Socket &socket)
void	close_socket (Socket &socket)
void	lock_socket_and_shutdown_and_close ()
bool	process_request (Stream &strm, Request &req, Response &res, bool close_connection, Error &error)
bool	write_content_with_provider (Stream &strm, const Request &req, Error &error)
void	copy_settings (const ClientImpl &rhs)

Protected Attributes
const std::string	host_
const int	port_
const std::string	host_and_port_
Socket	socket_
std::mutex	socket_mutex_
std::recursive_mutex	request_mutex_
size_t	socket_requests_in_flight_ = 0
std::thread::id	socket_requests_are_from_thread_ = std::thread::id()
bool	socket_should_be_closed_when_request_is_done_ = false
Headers	default_headers_
std::string	client_cert_path_
std::string	client_key_path_
time_t	connection_timeout_sec_ = 300
time_t	connection_timeout_usec_ = 0
time_t	read_timeout_sec_ = 5
time_t	read_timeout_usec_ = 0
time_t	write_timeout_sec_ = 5
time_t	write_timeout_usec_ = 0
std::string	basic_auth_username_
std::string	basic_auth_password_
std::string	bearer_token_auth_token_
bool	keep_alive_ = false
bool	follow_location_ = false
int	address_family_ = AF_UNSPEC
bool	tcp_nodelay_ = false
SocketOptions	socket_options_ = nullptr
bool	compress_ = false
bool	decompress_ = true
std::string	interface_
std::string	proxy_host_
int	proxy_port_ = -1
std::string	proxy_basic_auth_username_
std::string	proxy_basic_auth_password_
std::string	proxy_bearer_token_auth_token_
Logger	logger_

Constructor & Destructor Documentation

ClientImpl() [1/3]

httplib::ClientImpl::ClientImpl ( const std::string &  host )

explicit

ClientImpl() [2/3]

httplib::ClientImpl::ClientImpl ( const std::string &  host, int  port  )

explicit

ClientImpl() [3/3]

httplib::ClientImpl::ClientImpl ( const std::string &  host, int  port, const std::string &  client_cert_path, const std::string &  client_key_path  )

explicit

~ClientImpl()

virtual httplib::ClientImpl::~ClientImpl ( )

virtual

Member Function Documentation

close_socket()

void httplib::ClientImpl::close_socket ( Socket &  socket )

protected

copy_settings()

void httplib::ClientImpl::copy_settings ( const ClientImpl &  rhs )

protected

create_and_connect_socket()

virtual bool httplib::ClientImpl::create_and_connect_socket ( Socket &  socket, Error &  error  )

protectedvirtual

Delete() [1/6]

Result httplib::ClientImpl::Delete

(

const char *

path

)

Delete() [2/6]

Result httplib::ClientImpl::Delete	(	const char *	path,
		const char *	body,
		size_t	content_length,
		const char *	content_type
	)

Delete() [3/6]

Result httplib::ClientImpl::Delete	(	const char *	path,
		const Headers &	headers
	)

Delete() [4/6]

Result httplib::ClientImpl::Delete	(	const char *	path,
		const Headers &	headers,
		const char *	body,
		size_t	content_length,
		const char *	content_type
	)

Delete() [5/6]

Result httplib::ClientImpl::Delete	(	const char *	path,
		const Headers &	headers,
		const std::string &	body,
		const char *	content_type
	)

Delete() [6/6]

Result httplib::ClientImpl::Delete	(	const char *	path,
		const std::string &	body,
		const char *	content_type
	)

Get() [1/15]

Result httplib::ClientImpl::Get

(

const char *

path

)

Get() [2/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		const Headers &	headers
	)

Get() [3/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		const Headers &	headers,
		ContentReceiver	content_receiver
	)

Get() [4/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		const Headers &	headers,
		ContentReceiver	content_receiver,
		Progress	progress
	)

Get() [5/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		const Headers &	headers,
		Progress	progress
	)

Get() [6/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		const Headers &	headers,
		ResponseHandler	response_handler,
		ContentReceiver	content_receiver
	)

Get() [7/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		const Headers &	headers,
		ResponseHandler	response_handler,
		ContentReceiver	content_receiver,
		Progress	progress
	)

Get() [8/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		const Params &	params,
		const Headers &	headers,
		ContentReceiver	content_receiver,
		Progress	progress = nullptr
	)

Get() [9/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		const Params &	params,
		const Headers &	headers,
		Progress	progress = nullptr
	)

Get() [10/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		const Params &	params,
		const Headers &	headers,
		ResponseHandler	response_handler,
		ContentReceiver	content_receiver,
		Progress	progress = nullptr
	)

Get() [11/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		ContentReceiver	content_receiver
	)

Get() [12/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		ContentReceiver	content_receiver,
		Progress	progress
	)

Get() [13/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		Progress	progress
	)

Get() [14/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		ResponseHandler	response_handler,
		ContentReceiver	content_receiver
	)

Get() [15/15]

Result httplib::ClientImpl::Get	(	const char *	path,
		ResponseHandler	response_handler,
		ContentReceiver	content_receiver,
		Progress	progress
	)

Head() [1/2]

Result httplib::ClientImpl::Head

(

const char *

path

)

Head() [2/2]

Result httplib::ClientImpl::Head	(	const char *	path,
		const Headers &	headers
	)

is_socket_open()

size_t httplib::ClientImpl::is_socket_open

(

)

const

is_valid()

virtual bool httplib::ClientImpl::is_valid ( ) const

virtual

lock_socket_and_shutdown_and_close()

void httplib::ClientImpl::lock_socket_and_shutdown_and_close ( )

protected

Options() [1/2]

Result httplib::ClientImpl::Options

(

const char *

path

)

Options() [2/2]

Result httplib::ClientImpl::Options	(	const char *	path,
		const Headers &	headers
	)

Patch() [1/9]

Result httplib::ClientImpl::Patch

(

const char *

path

)

Patch() [2/9]

Result httplib::ClientImpl::Patch	(	const char *	path,
		const char *	body,
		size_t	content_length,
		const char *	content_type
	)

Patch() [3/9]

Result httplib::ClientImpl::Patch	(	const char *	path,
		const Headers &	headers,
		const char *	body,
		size_t	content_length,
		const char *	content_type
	)

Patch() [4/9]

Result httplib::ClientImpl::Patch	(	const char *	path,
		const Headers &	headers,
		const std::string &	body,
		const char *	content_type
	)

Patch() [5/9]

Result httplib::ClientImpl::Patch	(	const char *	path,
		const Headers &	headers,
		ContentProviderWithoutLength	content_provider,
		const char *	content_type
	)

Patch() [6/9]

Result httplib::ClientImpl::Patch	(	const char *	path,
		const Headers &	headers,
		size_t	content_length,
		ContentProvider	content_provider,
		const char *	content_type
	)

Patch() [7/9]

Result httplib::ClientImpl::Patch	(	const char *	path,
		const std::string &	body,
		const char *	content_type
	)

Patch() [8/9]

Result httplib::ClientImpl::Patch	(	const char *	path,
		ContentProviderWithoutLength	content_provider,
		const char *	content_type
	)

Patch() [9/9]

Result httplib::ClientImpl::Patch	(	const char *	path,
		size_t	content_length,
		ContentProvider	content_provider,
		const char *	content_type
	)

Post() [1/14]

Result httplib::ClientImpl::Post

(

const char *

path

)

Post() [2/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const char *	body,
		size_t	content_length,
		const char *	content_type
	)

Post() [3/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const Headers &	headers,
		const char *	body,
		size_t	content_length,
		const char *	content_type
	)

Post() [4/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const Headers &	headers,
		const MultipartFormDataItems &	items
	)

Post() [5/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const Headers &	headers,
		const MultipartFormDataItems &	items,
		const std::string &	boundary
	)

Post() [6/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const Headers &	headers,
		const Params &	params
	)

Post() [7/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const Headers &	headers,
		const std::string &	body,
		const char *	content_type
	)

Post() [8/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const Headers &	headers,
		ContentProviderWithoutLength	content_provider,
		const char *	content_type
	)

Post() [9/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const Headers &	headers,
		size_t	content_length,
		ContentProvider	content_provider,
		const char *	content_type
	)

Post() [10/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const MultipartFormDataItems &	items
	)

Post() [11/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const Params &	params
	)

Post() [12/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		const std::string &	body,
		const char *	content_type
	)

Post() [13/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		ContentProviderWithoutLength	content_provider,
		const char *	content_type
	)

Post() [14/14]

Result httplib::ClientImpl::Post	(	const char *	path,
		size_t	content_length,
		ContentProvider	content_provider,
		const char *	content_type
	)

process_request()

bool httplib::ClientImpl::process_request ( Stream &  strm, Request &  req, Response &  res, bool  close_connection, Error &  error  )

protected

Put() [1/11]

Result httplib::ClientImpl::Put

(

const char *

path

)

Put() [2/11]

Result httplib::ClientImpl::Put	(	const char *	path,
		const char *	body,
		size_t	content_length,
		const char *	content_type
	)

Put() [3/11]

Result httplib::ClientImpl::Put	(	const char *	path,
		const Headers &	headers,
		const char *	body,
		size_t	content_length,
		const char *	content_type
	)

Put() [4/11]

Result httplib::ClientImpl::Put	(	const char *	path,
		const Headers &	headers,
		const Params &	params
	)

Put() [5/11]

Result httplib::ClientImpl::Put	(	const char *	path,
		const Headers &	headers,
		const std::string &	body,
		const char *	content_type
	)

Put() [6/11]

Result httplib::ClientImpl::Put	(	const char *	path,
		const Headers &	headers,
		ContentProviderWithoutLength	content_provider,
		const char *	content_type
	)

Put() [7/11]

Result httplib::ClientImpl::Put	(	const char *	path,
		const Headers &	headers,
		size_t	content_length,
		ContentProvider	content_provider,
		const char *	content_type
	)

Put() [8/11]

Result httplib::ClientImpl::Put	(	const char *	path,
		const Params &	params
	)

Put() [9/11]

Result httplib::ClientImpl::Put	(	const char *	path,
		const std::string &	body,
		const char *	content_type
	)

Put() [10/11]

Result httplib::ClientImpl::Put	(	const char *	path,
		ContentProviderWithoutLength	content_provider,
		const char *	content_type
	)

Put() [11/11]

Result httplib::ClientImpl::Put	(	const char *	path,
		size_t	content_length,
		ContentProvider	content_provider,
		const char *	content_type
	)

send() [1/2]

Result httplib::ClientImpl::send

(

const Request &

req

)

send() [2/2]

bool httplib::ClientImpl::send	(	Request &	req,
		Response &	res,
		Error &	error
	)

send_()

Result httplib::ClientImpl::send_ ( Request &&  req )

protected

set_address_family()

void httplib::ClientImpl::set_address_family

(

int

family

)

set_basic_auth()

void httplib::ClientImpl::set_basic_auth	(	const char *	username,
		const char *	password
	)

set_bearer_token_auth()

void httplib::ClientImpl::set_bearer_token_auth

(

const char *

token

)

set_compress()

void httplib::ClientImpl::set_compress

(

bool

on

)

set_connection_timeout() [1/2]

template<class Rep , class Period >

void httplib::ClientImpl::set_connection_timeout

(

const std::chrono::duration< Rep, Period > &

duration

)

set_connection_timeout() [2/2]

void httplib::ClientImpl::set_connection_timeout	(	time_t	sec,
		time_t	usec = 0
	)

set_decompress()

void httplib::ClientImpl::set_decompress

(

bool

on

)

set_default_headers()

void httplib::ClientImpl::set_default_headers

(

Headers

headers

)

set_follow_location()

void httplib::ClientImpl::set_follow_location

(

bool

on

)

set_interface()

void httplib::ClientImpl::set_interface

(

const char *

intf

)

set_keep_alive()

void httplib::ClientImpl::set_keep_alive

(

bool

on

)

set_logger()

void httplib::ClientImpl::set_logger

(

Logger

logger

)

set_proxy()

void httplib::ClientImpl::set_proxy	(	const char *	host,
		int	port
	)

set_proxy_basic_auth()

void httplib::ClientImpl::set_proxy_basic_auth	(	const char *	username,
		const char *	password
	)

set_proxy_bearer_token_auth()

void httplib::ClientImpl::set_proxy_bearer_token_auth

(

const char *

token

)

set_read_timeout() [1/2]

template<class Rep , class Period >

void httplib::ClientImpl::set_read_timeout

(

const std::chrono::duration< Rep, Period > &

duration

)

set_read_timeout() [2/2]

void httplib::ClientImpl::set_read_timeout	(	time_t	sec,
		time_t	usec = 0
	)

set_socket_options()

void httplib::ClientImpl::set_socket_options

(

SocketOptions

socket_options

)

set_tcp_nodelay()

void httplib::ClientImpl::set_tcp_nodelay

(

bool

on

)

set_write_timeout() [1/2]

template<class Rep , class Period >

void httplib::ClientImpl::set_write_timeout

(

const std::chrono::duration< Rep, Period > &

duration

)

set_write_timeout() [2/2]

void httplib::ClientImpl::set_write_timeout	(	time_t	sec,
		time_t	usec = 0
	)

shutdown_socket()

void httplib::ClientImpl::shutdown_socket ( Socket &  socket )

protected

shutdown_ssl()

virtual void httplib::ClientImpl::shutdown_ssl ( Socket &  socket, bool  shutdown_gracefully  )

protectedvirtual

stop()

void httplib::ClientImpl::stop

(

)

write_content_with_provider()

bool httplib::ClientImpl::write_content_with_provider ( Stream &  strm, const Request &  req, Error &  error  )

protected

Member Data Documentation

address_family_

int httplib::ClientImpl::address_family_ = AF_UNSPEC

protected

basic_auth_password_

std::string httplib::ClientImpl::basic_auth_password_

protected

basic_auth_username_

std::string httplib::ClientImpl::basic_auth_username_

protected

bearer_token_auth_token_

std::string httplib::ClientImpl::bearer_token_auth_token_

protected

client_cert_path_

std::string httplib::ClientImpl::client_cert_path_

protected

client_key_path_

std::string httplib::ClientImpl::client_key_path_

protected

compress_

bool httplib::ClientImpl::compress_ = false

protected

connection_timeout_sec_

time_t httplib::ClientImpl::connection_timeout_sec_ = 300

protected

connection_timeout_usec_

time_t httplib::ClientImpl::connection_timeout_usec_ = 0

protected

decompress_

bool httplib::ClientImpl::decompress_ = true

protected

default_headers_

Headers httplib::ClientImpl::default_headers_

protected

follow_location_

bool httplib::ClientImpl::follow_location_ = false

protected

host_

const std::string httplib::ClientImpl::host_

protected

host_and_port_

const std::string httplib::ClientImpl::host_and_port_

protected

interface_

std::string httplib::ClientImpl::interface_

protected

keep_alive_

bool httplib::ClientImpl::keep_alive_ = false

protected

logger_

Logger httplib::ClientImpl::logger_

protected

port_

const int httplib::ClientImpl::port_

protected

proxy_basic_auth_password_

std::string httplib::ClientImpl::proxy_basic_auth_password_

protected

proxy_basic_auth_username_

std::string httplib::ClientImpl::proxy_basic_auth_username_

protected

proxy_bearer_token_auth_token_

std::string httplib::ClientImpl::proxy_bearer_token_auth_token_

protected

proxy_host_

std::string httplib::ClientImpl::proxy_host_

protected

proxy_port_

int httplib::ClientImpl::proxy_port_ = -1

protected

read_timeout_sec_

time_t httplib::ClientImpl::read_timeout_sec_ = 5

protected

read_timeout_usec_

time_t httplib::ClientImpl::read_timeout_usec_ = 0

protected

request_mutex_

std::recursive_mutex httplib::ClientImpl::request_mutex_

protected

socket_

Socket httplib::ClientImpl::socket_

protected

socket_mutex_

std::mutex httplib::ClientImpl::socket_mutex_

mutableprotected

socket_options_

SocketOptions httplib::ClientImpl::socket_options_ = nullptr

protected

socket_requests_are_from_thread_

std::thread::id httplib::ClientImpl::socket_requests_are_from_thread_ = std::thread::id()

protected

socket_requests_in_flight_

size_t httplib::ClientImpl::socket_requests_in_flight_ = 0

protected

socket_should_be_closed_when_request_is_done_

bool httplib::ClientImpl::socket_should_be_closed_when_request_is_done_ = false

protected

tcp_nodelay_

bool httplib::ClientImpl::tcp_nodelay_ = false

protected

write_timeout_sec_

time_t httplib::ClientImpl::write_timeout_sec_ = 5

protected

write_timeout_usec_

time_t httplib::ClientImpl::write_timeout_usec_ = 0

protected