Merge pull request #28 from lk-libs/limiting-bandwidth-usage

leventkaragol · web-flow · commit 0af9372810b3 · 2024-04-27T11:24:23.000+03:00
Limiting bandwidth usage
diff --git a/README.md b/README.md
@@ -24,6 +24,7 @@ Modern, non-blocking and exception free, header-only HTTP Client library for C++
 * [POST request with JSON data](#post-request-with-json-data)
 * [What about others? (PUT, DELETE, PATCH)](#what-about-others-put-delete-patch)
 * [How to ignore SSL certificate errors?](#how-to-ignore-ssl-certificate-errors)
+* [How can I limit download and upload bandwidth?](#how-can-i-limit-download-and-upload-bandwidth)
 * [Semantic Versioning](#semantic-versioning)
 * [Full function list](#full-function-list)
 * [License](#license)
@@ -387,6 +388,31 @@ int main() {
 ```
 
 
+## How can I limit download and upload bandwidth?
+
+If you do not want the bandwidth to exceed a certain limit during the download and upload process, you can determine the maximum limit that can be used in Bytes with the setDownloadBandwidthLimit and setUploadBandwidthLimit methods.
+
+```cpp
+#include <fstream>
+#include "libcpp-http-client.hpp"
+
+using namespace lklibs;
+
+int main() {
+    HttpRequest httpRequest("https://api.myproject.com");
+    
+    // You can set the download and upload bandwidth limit in bytes per second
+    auto response = httpRequest
+                    .setDownloadBandwidthLimit(10240) // 10 KB/sec
+                    .setUploadBandwidthLimit(20480) // 20 KB/sec
+                    .send()
+                    .get();
+    
+    return 0;
+}
+```
+
+
 ## Semantic Versioning
 
 Versioning of the library is done using conventional semantic versioning. Accordingly, 
diff --git a/examples/main.cpp b/examples/main.cpp
@@ -1,25 +1,24 @@
-#include <fstream>
 #include "libcpp-http-client.hpp"
 
 using namespace lklibs;
 
-void simpleGet() {
-
+void simpleGet()
+{
     HttpRequest httpRequest("https://httpbun.com/get");
 
     // The simplest but slowest method if multiple calls will be made
     auto response = httpRequest
-            .setQueryString("param1=7&param2=test")
-            .send()
-            .get();
+                    .setQueryString("param1=7&param2=test")
+                    .send()
+                    .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
     std::cout << "Data: " << response.textData << std::endl;
 }
 
-void nonBlockingGet() {
-
+void nonBlockingGet()
+{
     HttpRequest httpRequest1("https://httpbun.com/get");
     HttpRequest httpRequest2("https://httpbun.com/get");
     HttpRequest httpRequest3("https://httpbun.com/get");
@@ -47,15 +46,15 @@ void nonBlockingGet() {
     std::cout << "Response3 Data: " << response3.textData << std::endl;
 }
 
-void receiveBinaryData() {
-
+void receiveBinaryData()
+{
     HttpRequest httpRequest("https://httpbun.com/bytes/100");
 
     // If you need to retrieve binary data such as an image, just call the "returnAsBinary" method before send
     auto response = httpRequest
-            .returnAsBinary()
-            .send()
-            .get();
+                    .returnAsBinary()
+                    .send()
+                    .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
@@ -64,8 +63,8 @@ void receiveBinaryData() {
     std::cout << "Data Size: " << response.binaryData.size() << std::endl;
 }
 
-void receiveError() {
-
+void receiveError()
+{
     HttpRequest httpRequest("https://httpbun.com/not_found");
 
     // This is an exception free library. If an error occurs, no exception is thrown
@@ -81,103 +80,103 @@ void receiveError() {
     std::cout << "Error Message: " << response.errorMessage << std::endl;
 }
 
-void sendingHttpHeaders() {
-
+void sendingHttpHeaders()
+{
     HttpRequest httpRequest("https://httpbun.com/get?param1=7&param2=test");
 
     // You can send custom headers as key-value pairs
     auto response = httpRequest
-            .addHeader("Custom-Header1", "value1")
-            .addHeader("Custom-Header2", "value2")
-            .send()
-            .get();
+                    .addHeader("Custom-Header1", "value1")
+                    .addHeader("Custom-Header2", "value2")
+                    .send()
+                    .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
 }
 
-void simplePostWithFormData() {
-
+void simplePostWithFormData()
+{
     HttpRequest httpRequest("https://httpbun.com/post");
 
     // You can send a POST request with form data in the payload
     auto response = httpRequest
-            .setMethod(HttpMethod::POST)
-            .setPayload("param1=7&param2=test")
-            .send()
-            .get();
+                    .setMethod(HttpMethod::POST)
+                    .setPayload("param1=7&param2=test")
+                    .send()
+                    .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
     std::cout << "Data: " << response.textData << std::endl;
 }
 
-void simplePostWithJSONData() {
-
+void simplePostWithJSONData()
+{
     HttpRequest httpRequest("https://httpbun.com/post");
 
     // You need to send the "Content-Type" as "application/json" in the HTTP Header, if you need to send json data in the payload
     auto response = httpRequest
-            .setMethod(HttpMethod::POST)
-            .setPayload(R"({"param1": 7, "param2": "test"})")
-            .addHeader("Content-Type", "application/json")
-            .send()
-            .get();
+                    .setMethod(HttpMethod::POST)
+                    .setPayload(R"({"param1": 7, "param2": "test"})")
+                    .addHeader("Content-Type", "application/json")
+                    .send()
+                    .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
     std::cout << "Data: " << response.textData << std::endl;
 }
 
-void simplePutWithFormData() {
-
+void simplePutWithFormData()
+{
     HttpRequest httpRequest("https://httpbun.com/put");
 
     // You can send a PUT request with form data in the payload just like POST
     auto response = httpRequest
-            .setMethod(HttpMethod::PUT)
-            .setPayload("param1=7&param2=test")
-            .send()
-            .get();
+                    .setMethod(HttpMethod::PUT)
+                    .setPayload("param1=7&param2=test")
+                    .send()
+                    .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
     std::cout << "Data: " << response.textData << std::endl;
 }
 
-void simpleDeleteWithFormData() {
-
+void simpleDeleteWithFormData()
+{
     HttpRequest httpRequest("https://httpbun.com/delete");
 
     // You can send a DELETE request with form data in the payload just like POST
     auto response = httpRequest
-            .setMethod(HttpMethod::DELETE_)
-            .setPayload("param1=7&param2=test")
-            .send()
-            .get();
+                    .setMethod(HttpMethod::DELETE_)
+                    .setPayload("param1=7&param2=test")
+                    .send()
+                    .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
     std::cout << "Data: " << response.textData << std::endl;
 }
 
-void simplePatch() {
-
+void simplePatch()
+{
     HttpRequest httpRequest("https://httpbun.com/patch");
 
     // You can send a PATCH request with QueryString just like GET
     auto response = httpRequest
-            .setMethod(HttpMethod::PATCH)
-            .setQueryString("param1=7&param2=test")
-            .send()
-            .get();
+                    .setMethod(HttpMethod::PATCH)
+                    .setQueryString("param1=7&param2=test")
+                    .send()
+                    .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
     std::cout << "Data: " << response.textData << std::endl;
 }
 
-void ignoreSslErrors() {
-
+void ignoreSslErrors()
+{
     HttpRequest httpRequest("https://self-signed-cert.httpbun.com");
 
     // If you need to ignore SSL errors, you can call "ignoreSslErrors" method before sending the request
@@ -188,9 +187,25 @@ void ignoreSslErrors() {
     std::cout << "Data: " << response.textData << std::endl;
 }
 
+void setDownloadAndUploadBandwidthLimit()
+{
+    HttpRequest httpRequest("https://httpbun.com/get");
+
+    // You can set the download and upload bandwidth limit in bytes per second
+    auto response = httpRequest
+                    .setDownloadBandwidthLimit(10240) // 10 KB/sec
+                    .setUploadBandwidthLimit(20480) // 20 KB/sec
+                    .send()
+                    .get();
+
+    std::cout << "Succeed: " << response.succeed << std::endl;
+    std::cout << "Http Status Code: " << response.statusCode << std::endl;
+    std::cout << "Data: " << response.textData << std::endl;
+}
 
-int main() {
 
+int main()
+{
     simpleGet();
 
     nonBlockingGet();
@@ -213,5 +228,7 @@ int main() {
 
     ignoreSslErrors();
 
+    setDownloadAndUploadBandwidthLimit();
+
     return 0;
-}
+}
diff --git a/src/libcpp-http-client.hpp b/src/libcpp-http-client.hpp
@@ -224,6 +224,30 @@ namespace lklibs {
             return *this;
         }
 
+        /**
+         * @brief Set the download bandwidth limit for the request
+         *
+         * @param limit: Download bandwidth limit in bytes per second (0 for no limit)
+         */
+        HttpRequest &setDownloadBandwidthLimit(int limit) noexcept {
+
+            this->downloadBandwidthLimit = limit;
+
+            return *this;
+        }
+
+        /**
+         * @brief Set the upload bandwidth limit for the request
+         *
+         * @param limit: Upload bandwidth limit in bytes per second (0 for no limit)
+         */
+        HttpRequest &setUploadBandwidthLimit(int limit) noexcept {
+
+            this->uploadBandwidthLimit = limit;
+
+            return *this;
+        }
+
         /**
          * @brief Send the HTTP request and return the result as a future
          * The result can be obtained by calling the get() method of the future
@@ -258,6 +282,8 @@ namespace lklibs {
         bool sslErrorsWillBeIgnored = false;
         ReturnFormat returnFormat = ReturnFormat::TEXT;
         std::map<std::string, std::string> headers;
+        int uploadBandwidthLimit = 0;
+        int downloadBandwidthLimit = 0;
 
         struct CurlDeleter {
 
@@ -310,6 +336,9 @@ namespace lklibs {
                 curl_easy_setopt(curl.get(), CURLOPT_CUSTOMREQUEST, this->method.c_str());
                 curl_easy_setopt(curl.get(), CURLOPT_SSL_VERIFYPEER, this->sslErrorsWillBeIgnored ? 0L : 1L);
                 curl_easy_setopt(curl.get(), CURLOPT_SSL_VERIFYHOST, this->sslErrorsWillBeIgnored ? 0L : 1L);
+                curl_easy_setopt(curl.get(), CURLOPT_MAX_SEND_SPEED_LARGE, this->uploadBandwidthLimit);
+                curl_easy_setopt(curl.get(), CURLOPT_MAX_RECV_SPEED_LARGE, this->downloadBandwidthLimit);
+
 
                 if (!this->payload.empty()) {
 
diff --git a/test/test.cpp b/test/test.cpp
