httplib::Client Class Reference

#include <goby/util/thirdparty/cpp-httplib/httplib.h>

Public Member Functions
	Client (const std::string &scheme_host_port)
	Client (const std::string &scheme_host_port, const std::string &client_cert_path, const std::string &client_key_path)
	Client (const std::string &host, int port)
	Client (const std::string &host, int port, const std::string &client_cert_path, const std::string &client_key_path)
	Client (Client &&)=default
	~Client ()
bool	is_valid () const
Result	Get (const std::string &path)
Result	Get (const std::string &path, const Headers &headers)
Result	Get (const std::string &path, Progress progress)
Result	Get (const std::string &path, const Headers &headers, Progress progress)
Result	Get (const std::string &path, ContentReceiver content_receiver)
Result	Get (const std::string &path, const Headers &headers, ContentReceiver content_receiver)
Result	Get (const std::string &path, ContentReceiver content_receiver, Progress progress)
Result	Get (const std::string &path, const Headers &headers, ContentReceiver content_receiver, Progress progress)
Result	Get (const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver)
Result	Get (const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver)
Result	Get (const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress)
Result	Get (const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress)
Result	Get (const std::string &path, const Params &params, const Headers &headers, Progress progress=nullptr)
Result	Get (const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, Progress progress=nullptr)
Result	Get (const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress=nullptr)
Result	Head (const std::string &path)
Result	Head (const std::string &path, const Headers &headers)
Result	Post (const std::string &path)
Result	Post (const std::string &path, const Headers &headers)
Result	Post (const std::string &path, const char *body, size_t content_length, const std::string &content_type)
Result	Post (const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type)
Result	Post (const std::string &path, const std::string &body, const std::string &content_type)
Result	Post (const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type)
Result	Post (const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type)
Result	Post (const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type)
Result	Post (const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type)
Result	Post (const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type)
Result	Post (const std::string &path, const Params &params)
Result	Post (const std::string &path, const Headers &headers, const Params &params)
Result	Post (const std::string &path, const MultipartFormDataItems &items)
Result	Post (const std::string &path, const Headers &headers, const MultipartFormDataItems &items)
Result	Post (const std::string &path, const Headers &headers, const MultipartFormDataItems &items, const std::string &boundary)
Result	Post (const std::string &path, const Headers &headers, const MultipartFormDataItems &items, const MultipartFormDataProviderItems &provider_items)
Result	Put (const std::string &path)
Result	Put (const std::string &path, const char *body, size_t content_length, const std::string &content_type)
Result	Put (const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type)
Result	Put (const std::string &path, const std::string &body, const std::string &content_type)
Result	Put (const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type)
Result	Put (const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type)
Result	Put (const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type)
Result	Put (const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type)
Result	Put (const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type)
Result	Put (const std::string &path, const Params &params)
Result	Put (const std::string &path, const Headers &headers, const Params &params)
Result	Put (const std::string &path, const MultipartFormDataItems &items)
Result	Put (const std::string &path, const Headers &headers, const MultipartFormDataItems &items)
Result	Put (const std::string &path, const Headers &headers, const MultipartFormDataItems &items, const std::string &boundary)
Result	Put (const std::string &path, const Headers &headers, const MultipartFormDataItems &items, const MultipartFormDataProviderItems &provider_items)
Result	Patch (const std::string &path)
Result	Patch (const std::string &path, const char *body, size_t content_length, const std::string &content_type)
Result	Patch (const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type)
Result	Patch (const std::string &path, const std::string &body, const std::string &content_type)
Result	Patch (const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type)
Result	Patch (const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type)
Result	Patch (const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type)
Result	Patch (const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type)
Result	Patch (const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type)
Result	Delete (const std::string &path)
Result	Delete (const std::string &path, const Headers &headers)
Result	Delete (const std::string &path, const char *body, size_t content_length, const std::string &content_type)
Result	Delete (const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type)
Result	Delete (const std::string &path, const std::string &body, const std::string &content_type)
Result	Delete (const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type)
Result	Options (const std::string &path)
Result	Options (const std::string &path, const Headers &headers)
bool	send (Request &req, Response &res, Error &error)
Result	send (const Request &req)
void	stop ()
std::string	host () const
int	port () const
size_t	is_socket_open () const
socket_t	socket () const
void	set_hostname_addr_map (std::map< std::string, std::string > addr_map)
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 std::string &username, const std::string &password)
void	set_bearer_token_auth (const std::string &token)
void	set_keep_alive (bool on)
void	set_follow_location (bool on)
void	set_url_encode (bool on)
void	set_compress (bool on)
void	set_decompress (bool on)
void	set_interface (const std::string &intf)
void	set_proxy (const std::string &host, int port)
void	set_proxy_basic_auth (const std::string &username, const std::string &password)
void	set_proxy_bearer_token_auth (const std::string &token)
void	set_logger (Logger logger)

Detailed Description

Definition at line 1350 of file httplib.h.

Constructor & Destructor Documentation

Client() [1/5]

httplib::Client::Client ( const std::string & scheme_host_port )

inlineexplicit

Definition at line 10043 of file httplib.h.

Client() [2/5]

httplib::Client::Client ( const std::string & scheme_host_port, const std::string & client_cert_path, const std::string & client_key_path )

inlineexplicit

Definition at line 10048 of file httplib.h.

Client() [3/5]

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

inlineexplicit

Definition at line 10102 of file httplib.h.

Client() [4/5]

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

inlineexplicit

Definition at line 10107 of file httplib.h.

Client() [5/5]

httplib::Client::Client ( Client && )

default

~Client()

httplib::Client::~Client ( )

inline

Definition at line 10113 of file httplib.h.

Member Function Documentation

Delete() [1/6]

Result httplib::Client::Delete ( const std::string & path )

inline

Definition at line 10381 of file httplib.h.

Delete() [2/6]

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

inline

Definition at line 10386 of file httplib.h.

Delete() [3/6]

Result httplib::Client::Delete ( const std::string & path, const Headers & headers )

inline

Definition at line 10382 of file httplib.h.

Delete() [4/6]

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

inline

Definition at line 10391 of file httplib.h.

Delete() [5/6]

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

inline

Definition at line 10401 of file httplib.h.

Delete() [6/6]

Result httplib::Client::Delete ( const std::string & path, const std::string & body, const std::string & content_type )

inline

Definition at line 10396 of file httplib.h.

Get() [1/15]

Result httplib::Client::Get ( const std::string & path )

inline

Definition at line 10117 of file httplib.h.

Get() [2/15]

Result httplib::Client::Get ( const std::string & path, const Headers & headers )

inline

Definition at line 10118 of file httplib.h.

Get() [3/15]

Result httplib::Client::Get ( const std::string & path, const Headers & headers, ContentReceiver content_receiver )

inline

Definition at line 10134 of file httplib.h.

Get() [4/15]

Result httplib::Client::Get ( const std::string & path, const Headers & headers, ContentReceiver content_receiver, Progress progress )

inline

Definition at line 10144 of file httplib.h.

Get() [5/15]

Result httplib::Client::Get ( const std::string & path, const Headers & headers, Progress progress )

inline

Definition at line 10126 of file httplib.h.

Get() [6/15]

Result httplib::Client::Get ( const std::string & path, const Headers & headers, ResponseHandler response_handler, ContentReceiver content_receiver )

inline

Definition at line 10154 of file httplib.h.

Get() [7/15]

Result httplib::Client::Get ( const std::string & path, const Headers & headers, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress )

inline

Definition at line 10165 of file httplib.h.

Get() [8/15]

Result httplib::Client::Get ( const std::string & path, const Params & params, const Headers & headers, ContentReceiver content_receiver, Progress progress = nullptr )

inline

Definition at line 10177 of file httplib.h.

Get() [9/15]

Result httplib::Client::Get ( const std::string & path, const Params & params, const Headers & headers, Progress progress = nullptr )

inline

Definition at line 10172 of file httplib.h.

Get() [10/15]

Result httplib::Client::Get ( const std::string & path, const Params & params, const Headers & headers, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress = nullptr )

inline

Definition at line 10182 of file httplib.h.

Get() [11/15]

Result httplib::Client::Get ( const std::string & path, ContentReceiver content_receiver )

inline

Definition at line 10130 of file httplib.h.

Get() [12/15]

Result httplib::Client::Get ( const std::string & path, ContentReceiver content_receiver, Progress progress )

inline

Definition at line 10139 of file httplib.h.

Get() [13/15]

Result httplib::Client::Get ( const std::string & path, Progress progress )

inline

Definition at line 10122 of file httplib.h.

Get() [14/15]

Result httplib::Client::Get ( const std::string & path, ResponseHandler response_handler, ContentReceiver content_receiver )

inline

Definition at line 10149 of file httplib.h.

Get() [15/15]

Result httplib::Client::Get ( const std::string & path, ResponseHandler response_handler, ContentReceiver content_receiver, Progress progress )

inline

Definition at line 10159 of file httplib.h.

Head() [1/2]

Result httplib::Client::Head ( const std::string & path )

inline

Definition at line 10189 of file httplib.h.

Head() [2/2]

Result httplib::Client::Head ( const std::string & path, const Headers & headers )

inline

Definition at line 10190 of file httplib.h.

host()

std::string httplib::Client::host ( ) const

inline

Definition at line 10421 of file httplib.h.

is_socket_open()

size_t httplib::Client::is_socket_open ( ) const

inline

Definition at line 10425 of file httplib.h.

is_valid()

bool httplib::Client::is_valid ( ) const

inline

Definition at line 10115 of file httplib.h.

Options() [1/2]

Result httplib::Client::Options ( const std::string & path )

inline

Definition at line 10406 of file httplib.h.

Options() [2/2]

Result httplib::Client::Options ( const std::string & path, const Headers & headers )

inline

Definition at line 10407 of file httplib.h.

Patch() [1/9]

Result httplib::Client::Patch ( const std::string & path )

inline

Definition at line 10339 of file httplib.h.

Patch() [2/9]

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

inline

Definition at line 10340 of file httplib.h.

Patch() [3/9]

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

inline

Definition at line 10345 of file httplib.h.

Patch() [4/9]

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

inline

Definition at line 10355 of file httplib.h.

Patch() [5/9]

Result httplib::Client::Patch ( const std::string & path, const Headers & headers, ContentProviderWithoutLength content_provider, const std::string & content_type )

inline

Definition at line 10375 of file httplib.h.

Patch() [6/9]

Result httplib::Client::Patch ( const std::string & path, const Headers & headers, size_t content_length, ContentProvider content_provider, const std::string & content_type )

inline

Definition at line 10370 of file httplib.h.

Patch() [7/9]

Result httplib::Client::Patch ( const std::string & path, const std::string & body, const std::string & content_type )

inline

Definition at line 10350 of file httplib.h.

Patch() [8/9]

Result httplib::Client::Patch ( const std::string & path, ContentProviderWithoutLength content_provider, const std::string & content_type )

inline

Definition at line 10365 of file httplib.h.

Patch() [9/9]

Result httplib::Client::Patch ( const std::string & path, size_t content_length, ContentProvider content_provider, const std::string & content_type )

inline

Definition at line 10360 of file httplib.h.

port()

int httplib::Client::port ( ) const

inline

Definition at line 10423 of file httplib.h.

Post() [1/16]

Result httplib::Client::Post ( const std::string & path )

inline

Definition at line 10195 of file httplib.h.

Post() [2/16]

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

inline

Definition at line 10200 of file httplib.h.

Post() [3/16]

Result httplib::Client::Post ( const std::string & path, const Headers & headers )

inline

Definition at line 10196 of file httplib.h.

Post() [4/16]

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

inline

Definition at line 10205 of file httplib.h.

Post() [5/16]

Result httplib::Client::Post ( const std::string & path, const Headers & headers, const MultipartFormDataItems & items )

inline

Definition at line 10253 of file httplib.h.

Post() [6/16]

Result httplib::Client::Post ( const std::string & path, const Headers & headers, const MultipartFormDataItems & items, const MultipartFormDataProviderItems & provider_items )

inline

Definition at line 10263 of file httplib.h.

Post() [7/16]

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

inline

Definition at line 10258 of file httplib.h.

Post() [8/16]

Result httplib::Client::Post ( const std::string & path, const Headers & headers, const Params & params )

inline

Definition at line 10245 of file httplib.h.

Post() [9/16]

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

inline

Definition at line 10215 of file httplib.h.

Post() [10/16]

Result httplib::Client::Post ( const std::string & path, const Headers & headers, ContentProviderWithoutLength content_provider, const std::string & content_type )

inline

Definition at line 10235 of file httplib.h.

Post() [11/16]

Result httplib::Client::Post ( const std::string & path, const Headers & headers, size_t content_length, ContentProvider content_provider, const std::string & content_type )

inline

Definition at line 10230 of file httplib.h.

Post() [12/16]

Result httplib::Client::Post ( const std::string & path, const MultipartFormDataItems & items )

inline

Definition at line 10249 of file httplib.h.

Post() [13/16]

Result httplib::Client::Post ( const std::string & path, const Params & params )

inline

Definition at line 10241 of file httplib.h.

Post() [14/16]

Result httplib::Client::Post ( const std::string & path, const std::string & body, const std::string & content_type )

inline

Definition at line 10210 of file httplib.h.

Post() [15/16]

Result httplib::Client::Post ( const std::string & path, ContentProviderWithoutLength content_provider, const std::string & content_type )

inline

Definition at line 10225 of file httplib.h.

Post() [16/16]

Result httplib::Client::Post ( const std::string & path, size_t content_length, ContentProvider content_provider, const std::string & content_type )

inline

Definition at line 10220 of file httplib.h.

Put() [1/15]

Result httplib::Client::Put ( const std::string & path )

inline

Definition at line 10269 of file httplib.h.

Put() [2/15]

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

inline

Definition at line 10270 of file httplib.h.

Put() [3/15]

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

inline

Definition at line 10275 of file httplib.h.

Put() [4/15]

Result httplib::Client::Put ( const std::string & path, const Headers & headers, const MultipartFormDataItems & items )

inline

Definition at line 10323 of file httplib.h.

Put() [5/15]

Result httplib::Client::Put ( const std::string & path, const Headers & headers, const MultipartFormDataItems & items, const MultipartFormDataProviderItems & provider_items )

inline

Definition at line 10333 of file httplib.h.

Put() [6/15]

Result httplib::Client::Put ( const std::string & path, const Headers & headers, const MultipartFormDataItems & items, const std::string & boundary )

inline

Definition at line 10328 of file httplib.h.

Put() [7/15]

Result httplib::Client::Put ( const std::string & path, const Headers & headers, const Params & params )

inline

Definition at line 10315 of file httplib.h.

Put() [8/15]

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

inline

Definition at line 10285 of file httplib.h.

Put() [9/15]

Result httplib::Client::Put ( const std::string & path, const Headers & headers, ContentProviderWithoutLength content_provider, const std::string & content_type )

inline

Definition at line 10305 of file httplib.h.

Put() [10/15]

Result httplib::Client::Put ( const std::string & path, const Headers & headers, size_t content_length, ContentProvider content_provider, const std::string & content_type )

inline

Definition at line 10300 of file httplib.h.

Put() [11/15]

Result httplib::Client::Put ( const std::string & path, const MultipartFormDataItems & items )

inline

Definition at line 10319 of file httplib.h.

Put() [12/15]

Result httplib::Client::Put ( const std::string & path, const Params & params )

inline

Definition at line 10311 of file httplib.h.

Put() [13/15]

Result httplib::Client::Put ( const std::string & path, const std::string & body, const std::string & content_type )

inline

Definition at line 10280 of file httplib.h.

Put() [14/15]

Result httplib::Client::Put ( const std::string & path, ContentProviderWithoutLength content_provider, const std::string & content_type )

inline

Definition at line 10295 of file httplib.h.

Put() [15/15]

Result httplib::Client::Put ( const std::string & path, size_t content_length, ContentProvider content_provider, const std::string & content_type )

inline

Definition at line 10290 of file httplib.h.

send() [1/2]

Result httplib::Client::send ( const Request & req )

inline

Definition at line 10417 of file httplib.h.

send() [2/2]

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

inline

Definition at line 10412 of file httplib.h.

set_address_family()

void httplib::Client::set_address_family ( int family )

inline

Definition at line 10439 of file httplib.h.

set_basic_auth()

void httplib::Client::set_basic_auth ( const std::string & username, const std::string & password )

inline

Definition at line 10460 of file httplib.h.

set_bearer_token_auth()

void httplib::Client::set_bearer_token_auth ( const std::string & token )

inline

Definition at line 10464 of file httplib.h.

set_compress()

void httplib::Client::set_compress ( bool on )

inline

Definition at line 10480 of file httplib.h.

set_connection_timeout() [1/2]

template<class Rep, class Period>

void httplib::Client::set_connection_timeout ( const std::chrono::duration< Rep, Period > & duration )

inline

Definition at line 1892 of file httplib.h.

set_connection_timeout() [2/2]

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

inline

Definition at line 10448 of file httplib.h.

set_decompress()

void httplib::Client::set_decompress ( bool on )

inline

Definition at line 10482 of file httplib.h.

set_default_headers()

void httplib::Client::set_default_headers ( Headers headers )

inline

Definition at line 10434 of file httplib.h.

set_follow_location()

void httplib::Client::set_follow_location ( bool on )

inline

Definition at line 10476 of file httplib.h.

set_hostname_addr_map()

void httplib::Client::set_hostname_addr_map ( std::map< std::string, std::string > addr_map )

inline

Definition at line 10429 of file httplib.h.

set_interface()

void httplib::Client::set_interface ( const std::string & intf )

inline

Definition at line 10484 of file httplib.h.

set_keep_alive()

void httplib::Client::set_keep_alive ( bool on )

inline

Definition at line 10475 of file httplib.h.

set_logger()

void httplib::Client::set_logger ( Logger logger )

inline

Definition at line 10509 of file httplib.h.

set_proxy()

void httplib::Client::set_proxy ( const std::string & host, int port )

inline

Definition at line 10486 of file httplib.h.

set_proxy_basic_auth()

void httplib::Client::set_proxy_basic_auth ( const std::string & username, const std::string & password )

inline

Definition at line 10487 of file httplib.h.

set_proxy_bearer_token_auth()

void httplib::Client::set_proxy_bearer_token_auth ( const std::string & token )

inline

Definition at line 10491 of file httplib.h.

set_read_timeout() [1/2]

template<class Rep, class Period>

void httplib::Client::set_read_timeout ( const std::chrono::duration< Rep, Period > & duration )

inline

Definition at line 1898 of file httplib.h.

set_read_timeout() [2/2]

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

inline

Definition at line 10453 of file httplib.h.

set_socket_options()

void httplib::Client::set_socket_options ( SocketOptions socket_options )

inline

Definition at line 10443 of file httplib.h.

set_tcp_nodelay()

void httplib::Client::set_tcp_nodelay ( bool on )

inline

Definition at line 10441 of file httplib.h.

set_url_encode()

void httplib::Client::set_url_encode ( bool on )

inline

Definition at line 10478 of file httplib.h.

set_write_timeout() [1/2]

template<class Rep, class Period>

void httplib::Client::set_write_timeout ( const std::chrono::duration< Rep, Period > & duration )

inline

Definition at line 1904 of file httplib.h.

set_write_timeout() [2/2]

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

inline

Definition at line 10455 of file httplib.h.

socket()

socket_t httplib::Client::socket ( ) const

inline

Definition at line 10427 of file httplib.h.

stop()

void httplib::Client::stop ( )

inline

Definition at line 10419 of file httplib.h.

---

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

• goby/util/thirdparty/cpp-httplib/httplib.h