Class restincurl::Client

ClassList > restincurl > Client

#include <restincurl.h>

Public Functions

Type	Name
std::unique_ptr< RequestBuilder >	Build ()
	Client (const bool init=true)
void	Close ()
void	CloseWhenFinished ()
size_t	GetNumActiveRequests ()
bool	HaveWorker () const
void	WaitForFinish ()
virtual	~Client ()

Detailed Description

The high level abstraction of the Curl library.

An instance of a Client will, if asynchronous mode is enabled, create a worker-thread when the first request is made. This single worker-thread is then shared between all requests made for this client. When no requests are active, the thread will wait for a while (see RESTINCURL_IDLE_TIMEOUT_SEC), keeping libcurl's connection-cache warm, to serve new requests as efficiently as possible. When the idle time period expires, the thread will terminate and close the connection-cache associated with the client. If a new request is made later on, a new worker-thread will be created.

Public Functions Documentation

function Build

inline std::unique_ptr< RequestBuilder > restincurl::Client::Build ()

Build a request

Requests are "built" using a series of statements to fully express what you want to do and how you want RESTinCurl to do it.

Example

restincurl::Client client;
client.Build()->Get("https://api.example.com")
    .AcceptJson()
    .Header("X-Client", "restincurl")
    .WithCompletion([&](const Result& result) {
        // Do something
    })
    .Execute();

function Client

inline restincurl::Client::Client (
    const bool init=true
)

Constructor

Parameters:

init Set to true if you need to initialize libcurl.

Libcurl require us to call an initialization method once, before using the library. If you use libcurl exclusively from RESTinCurl, init needs to be true (default). If you use RESTinCurl in a project that already initialize libcurl, you should pass false to the constructor.

RESTinCurl will only call libcurl's initialization once, no matter how many times you call the constructor. It's therefore safe to always use the default value when you want RESTinCurl to deal with libcurl's initialization.

function Close

inline void restincurl::Client::Close ()

Close the client.

This method aborts any and all requests.

The worked-thread will exit shortly after this method is called, if it was running.