Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flaviotordini/http
Wrapper around Qt's HTTP APIs
https://github.com/flaviotordini/http
http http-client qt qt5 qt6
Last synced: about 1 month ago
JSON representation
Wrapper around Qt's HTTP APIs
- Host: GitHub
- URL: https://github.com/flaviotordini/http
- Owner: flaviotordini
- License: mit
- Created: 2016-06-29T16:32:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-21T09:41:56.000Z (about 1 year ago)
- Last Synced: 2024-09-29T07:41:50.554Z (about 2 months ago)
- Topics: http, http-client, qt, qt5, qt6
- Language: C++
- Homepage: https://flavio.tordini.org
- Size: 74.2 KB
- Stars: 110
- Watchers: 6
- Forks: 28
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# A wrapper for the Qt Network Access API
This is just a wrapper around Qt's QNetworkAccessManager and friends. I use it in my apps at https://flavio.tordini.org . It has a simpler, higher-level API and some functionality not found in Qt:
- Throttling (as required by many web APIs nowadays)
- Automatic retries
- User agent and request header defaults
- Partial requests
- Easier POST requests
- Read timeouts (don't let your requests get stuck forever). (now supported by Qt >= 5.15)
- Redirection support (now supported by Qt >= 5.6)
- Disk-based cache implementation similar to Qt's but not strictly a HTTP cache, i.e. it ignores HTTP headers. This is good if want to cache successful requests irrespective of what the origin server says you should do. The cache also fallbacks to stale content when the server returns an error.
## Design
This library uses the [Decorator design pattern](https://en.wikipedia.org/wiki/Decorator_pattern) to modularize features and make it easy to add them and use them as needed. The main class is [Http](https://github.com/flaviotordini/http/blob/master/src/http.h), which implements the base features of a HTTP client. More specialized classes are:
- [CachedHttp](https://github.com/flaviotordini/http/blob/master/src/cachedhttp.h), a simple disk-based cache
- [ThrottledHttp](https://github.com/flaviotordini/http/blob/master/src/throttledhttp.h), implements request throttling (aka limiting)
The constructor of these classes takes another Http instance for which they will act as a proxy. (See examples below). Following this design you can create your own Http subclass. For example, a different caching mechanism, an event dispatcher, custom request logging, etc.
## Build Instructions
In order to build this library you can use either `qmake` or `cmake`.
### qmake
```shell
mkdir build
cd build
qmake ..
make
```
### CMake
```shell
mkdir build
cd build
cmake ..
make
```
## Integration
You can use this library as a git submodule. For example, add it to your project inside a lib subdirectory:
```shell
git submodule add -b master https://github.com/flaviotordini/http lib/http
```
Then you can update your git submodules like this:
```shell
git submodule update --init --recursive --remote
```
To integrate the library in your qmake based project just add this to your .pro file:
```qmake
include(lib/http/http.pri)
```
qmake builds all object files in the same directory. In order to avoid filename clashes use:
```qmake
CONFIG += object_parallel_to_source
```
If you are using CMake you can integrate the library by adding the following lines to your CMakeLists.txt:
```cmake
add_subdirectory(lib/http)
...
target_link_library(your_super_cool_project http)
```
or if you have installed http you can find it via:
```cmake
find_library(http REQUIRED)
...
target_link_library(your_super_cool_project http)
```
## Examples
A basic C++14 example:
```cpp
#include "http.h"
auto reply = Http::instance().get("https://flavio.tordini.org/");
connect(reply, &HttpReply::finished, this, [](auto &reply) {
if (reply.isSuccessful()) {
qDebug() << "Feel the bytes!" << reply.body();
} else {
qDebug() << "Something's wrong here" << reply.statusCode() << reply.reasonPhrase();
}
});
```
It is important to use the reply object passed by the `finished` signal as it may be a different object than the one used to make the request. For example it may be created by `CacheHttp` or other specialized `Http` subclasses.
Example using two separate signals for success and failure:
```cpp
#include "http.h"
auto reply = Http::instance().get("https://google.com/");
connect(reply, &HttpReply::data, this, [](auto &bytes) {
qDebug() << "Feel the bytes!" << bytes;
});
connect(reply, &HttpReply::error, this, [](auto &msg) {
qDebug() << "Something's wrong here" << msg;
});
```
A POST example taking advantage of C++11 initializer lists:
```cpp
QUrl url("https://some.domain.url/");
auto reply = Http::instance().post(url, {{"myparam", "paramvalue"}, {"otherparam", "foo"}});
connect(reply, &HttpReply::finished, this, [](auto &reply) {
if (reply.isSuccessful()) {
qDebug() << "Feel the bytes!" << reply.body();
} else {
qDebug() << "Something's wrong here" << reply.statusCode() << reply.reasonPhrase();
}
});
```
This is a real-world example of building a Http object with more complex features. It throttles requests, uses a custom user agent and caches results:
```cpp
#include "http.h"
#include "cachedhttp.h"
#include "throttledhttp.h"
Http &myHttp() {
static Http *http = [] {
auto http = new Http;
http->addRequestHeader("User-Agent", "MyUserAgent");
auto throttledHttp = new ThrottledHttp(*http);
throttledHttp->setMilliseconds(1000);
auto cachedHttp = new CachedHttp(*throttledHttp, "mycache");
cachedHttp->setMaxSeconds(86400 * 30);
return cachedHttp;
}();
return *http;
}
```
If the full power (and complexity) of QNetworkReply is needed you can always fallback to it:
```cpp
#include "http.h"
HttpRequest req;
req.url = "https://flavio.tordini.org/";
QNetworkReply *reply = Http::instance().networkReply(req);
// Use QNetworkReply as needed...
```
Note that features like redirection, retries and read timeouts won't work in this mode.
## License
You can use this library under the MIT license and at your own risk. If you do, you're welcome contributing your changes and fixes.