|
Use one of these functions to declare what HTTP request you want to use.
- Parameters
-
| url | Url to call. Must be a complete URL, starting with "http://" or "https://" |
Note that you must use only only one of these methods in one request.
|
| RequestBuilder & | Get (const std::string &url) |
| |
| RequestBuilder & | Head (const std::string &url) |
| |
| RequestBuilder & | Post (const std::string &url) |
| |
| RequestBuilder & | PostMime (const std::string &url) |
| |
| RequestBuilder & | Put (const std::string &url) |
| |
| RequestBuilder & | Patch (const std::string &url) |
| |
| RequestBuilder & | Delete (const std::string &url) |
| |
| RequestBuilder & | Options (const std::string &url) |
| |
| RequestBuilder & | Header (const char *value) |
| |
| RequestBuilder & | Header (const std::string &name, const std::string &value) |
| |
| RequestBuilder & | WithJson () |
| |
| RequestBuilder & | WithJson (std::string body) |
| |
| RequestBuilder & | AcceptJson () |
| |
| template<typename T> |
| RequestBuilder & | Option (const CURLoption &opt, const T &value) |
| |
| RequestBuilder & | Trace (bool enable=true) |
| |
| RequestBuilder & | RequestTimeout (const long timeout) |
| |
| RequestBuilder & | ConnectTimeout (const long timeout) |
| |
| RequestBuilder & | SendFile (const std::string &path) |
| |
| RequestBuilder & | SendFileAsMimeData (const std::string &path, const std::string &name={}, const std::string &remoteName={}, const std::string &mimeType={}) |
| |
| RequestBuilder & | SendFileAsForm (const std::string &path) |
| |
| template<typename T> |
| RequestBuilder & | SendData (OutDataHandler< T > &dh) |
| |
| template<typename T> |
| RequestBuilder & | SendData (T data) |
| |
| template<typename T> |
| RequestBuilder & | StoreData (InDataHandler< T > &dh) |
| |
| template<typename T> |
| RequestBuilder & | StoreData (T &data) |
| |
| RequestBuilder & | IgnoreIncomingData () |
| |
| RequestBuilder & | WithCompletion (completion_fn_t fn) |
| |
| RequestBuilder & | BasicAuthentication (const std::string &name, const std::string &passwd) |
| |
| RequestBuilder & | SetReadHandler (size_t(*handler)(char *, size_t, size_t, void *), void *userdata) |
| |
| RequestBuilder & | SetWriteHandler (size_t(*handler)(char *, size_t, size_t, void *), void *userdata) |
| |
| void | Build () |
| |
| void | ExecuteSynchronous () |
| |
| void | Execute () |
| |
Convenient interface to build requests.
Even if this is a light-weight wrapper around libcurl, we have a simple and modern way to define our requests that contains convenience-methods for the most common use-cases.
| RequestBuilder & restincurl::RequestBuilder::BasicAuthentication |
( |
const std::string & | name, |
|
|
const std::string & | passwd ) |
|
inline |
HTTP Basic Authentication
Authenticate the request with HTTP Basic Authentication.
- Parameters
-
| name | Name to authenticate with |
| passwd | Password to authenticate with |
Note that if name or password is empty, authentication is ignored. This makes it simple to add optional authentication to your project, by simply assigning values to the strings you pass here, or not.
References RequestBuilder().
| void restincurl::RequestBuilder::Execute |
( |
| ) |
|
|
inline |
Execute the request asynchronously
This will queue the request for processing. If the number of active requests are less than RESTINCURL_MAX_CONNECTIONS, the request will start executing almost immediately.
The method returns immediately.
- Exceptions
-
This method is only available when RESTINCURL_ENABLE_ASYNC is nonzero.
References Build().
Specify Data Handler for outbound data
You can use this method when you need to use a Data Handler, rather than a simple string, to provide the data for a POST, PUT etc. request.
- Parameters
-
Note that the Data Handler is passed by reference. It is your responsibility that the instance is present at least until the request has finished (your code owns the Data Handler instance).
References restincurl::OutDataHandler< T >::read_callback(), and RequestBuilder().
Referenced by SendData(), and WithJson().
Specify Data Handler for inbound data
You can use this method when you need to use a Data Handler, rather than a simple string, to receive data during the request.
- Parameters
-
Note that the Data Handler is passed by reference. It is your responsibility that the instance is present at least until the request has finished (your code owns the Data Handler instance).
References RequestBuilder(), and restincurl::InDataHandler< T >::write_callback().
Referenced by Build(), and StoreData().
Specify a callback that will be called when the request is complete (or failed).
- Parameters
-
For asynchronous requests, the callback will be called from the worker-thread shared by all requests and timers for the client instance. It is imperative that you return immediately, and don't keep the thread busy more than strictly required. If you need do do some computing or IO in response to the information you receive, you should do that in another thread.
References RequestBuilder().
