Add verbose, keepalive, keepidle, keepintvl to c-libcurl (#21613)

* Add keepalive to c-libcurl

* Fix manual tests on client/petstore/c

* Update Readme of c/libcurl

* better curlConfig handling on c-libcurl

Author: hirishh

modules/openapi-generator/src/main/resources/C-libcurl/README.md.mustache

@@ -15,16 +15,16 @@ For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
 {{/infoUrl}}
 
 ## Installation
-You'll need the `curl 7.58.0` package in order to build the API. To have code formatted nicely, you also need to have uncrustify version 0.67 or later.
+You'll need the `curl 7.61.1` package in order to build the API. To have code formatted nicely, you also need to have uncrustify version 0.67 or later.
 
 # Prerequisites
 
-## Install the `curl 7.58.0` package with the following command on Linux.
+## Install the `curl 7.61.1` package with the following command on Linux.
 ```bash
 sudo apt remove curl
-wget http://curl.haxx.se/download/curl-7.58.0.tar.gz
-tar -xvf curl-7.58.0.tar.gz
-cd curl-7.58.0/
+wget http://curl.haxx.se/download/curl-7.61.1.tar.gz
+tar -xvf curl-7.61.1.tar.gz
+cd curl-7.61.1/
 ./configure
 make
 sudo make install

modules/openapi-generator/src/main/resources/C-libcurl/apiClient.c.mustache

@@ -10,6 +10,7 @@ apiClient_t *apiClient_create() {
     apiClient_t *apiClient = malloc(sizeof(apiClient_t));
     apiClient->basePath = strdup("{{{basePath}}}");
     apiClient->sslConfig = NULL;
+    apiClient->curlConfig = NULL;
     apiClient->dataReceived = NULL;
     apiClient->dataReceivedLen = 0;
     apiClient->data_callback_func = NULL;
@@ -60,6 +61,12 @@ apiClient_t *apiClient_create_with_base_path(const char *basePath
         apiClient->sslConfig = NULL;
     }
 
+    apiClient->curlConfig = malloc(sizeof(curlConfig_t));
+    apiClient->curlConfig->verbose = 0;
+    apiClient->curlConfig->keepalive = 0;
+    apiClient->curlConfig->keepidle = 120;
+    apiClient->curlConfig->keepintvl = 60;
+
     apiClient->dataReceived = NULL;
     apiClient->dataReceivedLen = 0;
     apiClient->data_callback_func = NULL;
@@ -142,6 +149,12 @@ void apiClient_free(apiClient_t *apiClient) {
     {{/isApiKey}}
     {{/authMethods}}
     {{/hasAuthMethods}}
+
+    if(apiClient->curlConfig) {
+        free(apiClient->curlConfig);
+        apiClient->curlConfig = NULL;
+    }
+
     free(apiClient);
 }
 
@@ -498,7 +511,6 @@ void apiClient_invoke(apiClient_t    *apiClient,
                          CURLOPT_WRITEDATA,
                          apiClient);
         curl_easy_setopt(handle, CURLOPT_HTTPHEADER, headers);
-        curl_easy_setopt(handle, CURLOPT_VERBOSE, 0); // to get curl debug msg 0: to disable, 1L:to enable
 
         {{#hasAuthMethods}}
         {{#authMethods}}
@@ -543,6 +555,15 @@ void apiClient_invoke(apiClient_t    *apiClient,
             postData(handle, bodyParameters, bodyParametersLength);
         }
 
+        if(apiClient->curlConfig != NULL) {
+            if(apiClient->curlConfig->keepalive == 1) {
+                curl_easy_setopt(handle, CURLOPT_TCP_KEEPALIVE, 1L);
+                curl_easy_setopt(handle, CURLOPT_TCP_KEEPIDLE, apiClient->curlConfig->keepidle);
+                curl_easy_setopt(handle, CURLOPT_TCP_KEEPINTVL, apiClient->curlConfig->keepintvl);
+            }
+            curl_easy_setopt(handle, CURLOPT_VERBOSE, apiClient->curlConfig->verbose);
+        }
+
         res = curl_easy_perform(handle);
 
         curl_slist_free_all(headers);

modules/openapi-generator/src/main/resources/C-libcurl/apiClient.h.mustache

@@ -19,9 +19,19 @@ typedef struct sslConfig_t {
                                   /* 1 -- skip ssl verify for server certificate */
 } sslConfig_t;
 
+typedef struct curlConfig_t {
+    long verbose;   /* 0 -- disable verbose (default) */
+                    /* 1 -- enable verbose */
+    int keepalive;  /* 0 -- disable keepalive (default) */
+                    /* 1 -- enable keepalive */
+    long keepidle;  /* keep-alive idle time: default to 120 seconds */
+    long keepintvl; /* interval time between keep-alive probes: default to 60 seconds */
+} curlConfig_t;
+
 typedef struct apiClient_t {
     char *basePath;
     sslConfig_t *sslConfig;
+    curlConfig_t *curlConfig;
     void *dataReceived;
     long dataReceivedLen;
     void (*data_callback_func)(void **, long *);

samples/client/others/c/bearerAuth/README.md

@@ -9,16 +9,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
 - Build package: org.openapitools.codegen.languages.CLibcurlClientCodegen
 
 ## Installation
-You'll need the `curl 7.58.0` package in order to build the API. To have code formatted nicely, you also need to have uncrustify version 0.67 or later.
+You'll need the `curl 7.61.1` package in order to build the API. To have code formatted nicely, you also need to have uncrustify version 0.67 or later.
 
 # Prerequisites
 
-## Install the `curl 7.58.0` package with the following command on Linux.
+## Install the `curl 7.61.1` package with the following command on Linux.
 ```bash
 sudo apt remove curl
-wget http://curl.haxx.se/download/curl-7.58.0.tar.gz
-tar -xvf curl-7.58.0.tar.gz
-cd curl-7.58.0/
+wget http://curl.haxx.se/download/curl-7.61.1.tar.gz
+tar -xvf curl-7.61.1.tar.gz
+cd curl-7.61.1/
 ./configure
 make
 sudo make install

samples/client/others/c/bearerAuth/include/apiClient.h

@@ -19,9 +19,19 @@ typedef struct sslConfig_t {
                                   /* 1 -- skip ssl verify for server certificate */
 } sslConfig_t;
 
+typedef struct curlConfig_t {
+    long verbose;   /* 0 -- disable verbose (default) */
+                    /* 1 -- enable verbose */
+    int keepalive;  /* 0 -- disable keepalive (default) */
+                    /* 1 -- enable keepalive */
+    long keepidle;  /* keep-alive idle time: default to 120 seconds */
+    long keepintvl; /* interval time between keep-alive probes: default to 60 seconds */
+} curlConfig_t;
+
 typedef struct apiClient_t {
     char *basePath;
     sslConfig_t *sslConfig;
+    curlConfig_t *curlConfig;
     void *dataReceived;
     long dataReceivedLen;
     void (*data_callback_func)(void **, long *);

samples/client/others/c/bearerAuth/src/apiClient.c

@@ -10,6 +10,7 @@ apiClient_t *apiClient_create() {
     apiClient_t *apiClient = malloc(sizeof(apiClient_t));
     apiClient->basePath = strdup("http://api.example.com/v1");
     apiClient->sslConfig = NULL;
+    apiClient->curlConfig = NULL;
     apiClient->dataReceived = NULL;
     apiClient->dataReceivedLen = 0;
     apiClient->data_callback_func = NULL;
@@ -37,6 +38,12 @@ apiClient_t *apiClient_create_with_base_path(const char *basePath
         apiClient->sslConfig = NULL;
     }
 
+    apiClient->curlConfig = malloc(sizeof(curlConfig_t));
+    apiClient->curlConfig->verbose = 0;
+    apiClient->curlConfig->keepalive = 0;
+    apiClient->curlConfig->keepidle = 120;
+    apiClient->curlConfig->keepintvl = 60;
+
     apiClient->dataReceived = NULL;
     apiClient->dataReceivedLen = 0;
     apiClient->data_callback_func = NULL;
@@ -58,6 +65,12 @@ void apiClient_free(apiClient_t *apiClient) {
     if(apiClient->accessToken) {
         free(apiClient->accessToken);
     }
+
+    if(apiClient->curlConfig) {
+        free(apiClient->curlConfig);
+        apiClient->curlConfig = NULL;
+    }
+
     free(apiClient);
 }
 
@@ -391,13 +404,21 @@ void apiClient_invoke(apiClient_t    *apiClient,
                          CURLOPT_WRITEDATA,
                          apiClient);
         curl_easy_setopt(handle, CURLOPT_HTTPHEADER, headers);
-        curl_easy_setopt(handle, CURLOPT_VERBOSE, 0); // to get curl debug msg 0: to disable, 1L:to enable
 
 
         if(bodyParameters != NULL) {
             postData(handle, bodyParameters, bodyParametersLength);
         }
 
+        if(apiClient->curlConfig != NULL) {
+            if(apiClient->curlConfig->keepalive == 1) {
+                curl_easy_setopt(handle, CURLOPT_TCP_KEEPALIVE, 1L);
+                curl_easy_setopt(handle, CURLOPT_TCP_KEEPIDLE, apiClient->curlConfig->keepidle);
+                curl_easy_setopt(handle, CURLOPT_TCP_KEEPINTVL, apiClient->curlConfig->keepintvl);
+            }
+            curl_easy_setopt(handle, CURLOPT_VERBOSE, apiClient->curlConfig->verbose);
+        }
+
         res = curl_easy_perform(handle);
 
         curl_slist_free_all(headers);

samples/client/petstore/c-useJsonUnformatted/README.md

@@ -9,16 +9,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
 - Build package: org.openapitools.codegen.languages.CLibcurlClientCodegen
 
 ## Installation
-You'll need the `curl 7.58.0` package in order to build the API. To have code formatted nicely, you also need to have uncrustify version 0.67 or later.
+You'll need the `curl 7.61.1` package in order to build the API. To have code formatted nicely, you also need to have uncrustify version 0.67 or later.
 
 # Prerequisites
 
-## Install the `curl 7.58.0` package with the following command on Linux.
+## Install the `curl 7.61.1` package with the following command on Linux.
 ```bash
 sudo apt remove curl
-wget http://curl.haxx.se/download/curl-7.58.0.tar.gz
-tar -xvf curl-7.58.0.tar.gz
-cd curl-7.58.0/
+wget http://curl.haxx.se/download/curl-7.61.1.tar.gz
+tar -xvf curl-7.61.1.tar.gz
+cd curl-7.61.1/
 ./configure
 make
 sudo make install

samples/client/petstore/c-useJsonUnformatted/include/apiClient.h

@@ -19,9 +19,19 @@ typedef struct sslConfig_t {
                                   /* 1 -- skip ssl verify for server certificate */
 } sslConfig_t;
 
+typedef struct curlConfig_t {
+    long verbose;   /* 0 -- disable verbose (default) */
+                    /* 1 -- enable verbose */
+    int keepalive;  /* 0 -- disable keepalive (default) */
+                    /* 1 -- enable keepalive */
+    long keepidle;  /* keep-alive idle time: default to 120 seconds */
+    long keepintvl; /* interval time between keep-alive probes: default to 60 seconds */
+} curlConfig_t;
+
 typedef struct apiClient_t {
     char *basePath;
     sslConfig_t *sslConfig;
+    curlConfig_t *curlConfig;
     void *dataReceived;
     long dataReceivedLen;
     void (*data_callback_func)(void **, long *);

samples/client/petstore/c-useJsonUnformatted/src/apiClient.c

@@ -10,6 +10,7 @@ apiClient_t *apiClient_create() {
     apiClient_t *apiClient = malloc(sizeof(apiClient_t));
     apiClient->basePath = strdup("http://petstore.swagger.io/v2");
     apiClient->sslConfig = NULL;
+    apiClient->curlConfig = NULL;
     apiClient->dataReceived = NULL;
     apiClient->dataReceivedLen = 0;
     apiClient->data_callback_func = NULL;
@@ -39,6 +40,12 @@ apiClient_t *apiClient_create_with_base_path(const char *basePath
         apiClient->sslConfig = NULL;
     }
 
+    apiClient->curlConfig = malloc(sizeof(curlConfig_t));
+    apiClient->curlConfig->verbose = 0;
+    apiClient->curlConfig->keepalive = 0;
+    apiClient->curlConfig->keepidle = 120;
+    apiClient->curlConfig->keepintvl = 60;
+
     apiClient->dataReceived = NULL;
     apiClient->dataReceivedLen = 0;
     apiClient->data_callback_func = NULL;
@@ -85,6 +92,12 @@ void apiClient_free(apiClient_t *apiClient) {
         }
         list_freeList(apiClient->apiKeys_api_key);
     }
+
+    if(apiClient->curlConfig) {
+        free(apiClient->curlConfig);
+        apiClient->curlConfig = NULL;
+    }
+
     free(apiClient);
 }
 
@@ -421,7 +434,6 @@ void apiClient_invoke(apiClient_t    *apiClient,
                          CURLOPT_WRITEDATA,
                          apiClient);
         curl_easy_setopt(handle, CURLOPT_HTTPHEADER, headers);
-        curl_easy_setopt(handle, CURLOPT_VERBOSE, 0); // to get curl debug msg 0: to disable, 1L:to enable
 
         // this would only be generated for OAuth2 authentication
         if(apiClient->accessToken != NULL) {
@@ -435,6 +447,15 @@ void apiClient_invoke(apiClient_t    *apiClient,
             postData(handle, bodyParameters, bodyParametersLength);
         }
 
+        if(apiClient->curlConfig != NULL) {
+            if(apiClient->curlConfig->keepalive == 1) {
+                curl_easy_setopt(handle, CURLOPT_TCP_KEEPALIVE, 1L);
+                curl_easy_setopt(handle, CURLOPT_TCP_KEEPIDLE, apiClient->curlConfig->keepidle);
+                curl_easy_setopt(handle, CURLOPT_TCP_KEEPINTVL, apiClient->curlConfig->keepintvl);
+            }
+            curl_easy_setopt(handle, CURLOPT_VERBOSE, apiClient->curlConfig->verbose);
+        }
+
         res = curl_easy_perform(handle);
 
         curl_slist_free_all(headers);

samples/client/petstore/c/README.md

@@ -9,16 +9,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
 - Build package: org.openapitools.codegen.languages.CLibcurlClientCodegen
 
 ## Installation
-You'll need the `curl 7.58.0` package in order to build the API. To have code formatted nicely, you also need to have uncrustify version 0.67 or later.
+You'll need the `curl 7.61.1` package in order to build the API. To have code formatted nicely, you also need to have uncrustify version 0.67 or later.
 
 # Prerequisites
 
-## Install the `curl 7.58.0` package with the following command on Linux.
+## Install the `curl 7.61.1` package with the following command on Linux.
 ```bash
 sudo apt remove curl
-wget http://curl.haxx.se/download/curl-7.58.0.tar.gz
-tar -xvf curl-7.58.0.tar.gz
-cd curl-7.58.0/
+wget http://curl.haxx.se/download/curl-7.61.1.tar.gz
+tar -xvf curl-7.61.1.tar.gz
+cd curl-7.61.1/
 ./configure
 make
 sudo make install