Skip to content

Add keep alive enable configuration to the EspHttpConnection. #579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gustavowd wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add keep alive enable configuration to the EspHttpConnection. #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4a9a70
Added keep_alive_enable in the Configuration structure that is used i…
gustavowd Apr 23, 2025
feea628
fix fmt error
gustavowd Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- OTA: Allow specifying image size to speed up erase
- Bluetooth: New methods `EspBleGap::start_scanning` and `EspBleGap::stop_scanning`
- New example, `bt_ble_gap_scanner` to demonstrate usage of added ble scanning methods
- Added keep_alive_enable in the Configuration structure that is used in the EspHttpConnection function

## [0.51.0] - 2025-01-15

Expand Down
5 changes: 5 additions & 0 deletions src/http/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ pub struct Configuration {
pub use_global_ca_store: bool,
pub crt_bundle_attach: Option<unsafe extern "C" fn(conf: *mut core::ffi::c_void) -> esp_err_t>,
pub raw_request_body: bool,
pub keep_alive_enable: Option<bool>,

@ivmarkov ivmarkov Apr 27, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does None mean for keep_alive_enabled? If it means same as Some(false), then why are we hiding this flag behind an Option?

@gustavowd gustavowd Apr 29, 2025

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does None mean for keep_alive_enabled? If it means same as Some(false), then why are we hiding this flag behind an Option?

In fact, None would cause the http client library to use the default option for keep_alive_enabled, which is currently false. However, if the library changes in the future and starts specifying this option as true by default, None would maintain this condition.

In any case, I have no objection to removing the Option and specifying just a boolean.

@ivmarkov ivmarkov Apr 29, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is simpler for the users to just use false.

Moreover, there is no such thing as a predefined default in esp-idf that might change. The C struct is initially just all zeroes, which for that particular parameter corresponds to false.

@gustavowd gustavowd May 7, 2025

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ivmarkov

Actually, there is a default configuration for keep alive if you set in the config keep_alive_enable to true.

static bool init_common_tcp_transport(esp_http_client_handle_t client, const esp_http_client_config_t *config, esp_transport_handle_t transport)
{
    if (config->keep_alive_enable == true) {
        client->keep_alive_cfg.keep_alive_enable = true;
        client->keep_alive_cfg.keep_alive_idle = (config->keep_alive_idle == 0) ? DEFAULT_KEEP_ALIVE_IDLE : config->keep_alive_idle;
        client->keep_alive_cfg.keep_alive_interval = (config->keep_alive_interval == 0) ? DEFAULT_KEEP_ALIVE_INTERVAL : config->keep_alive_interval;
        client->keep_alive_cfg.keep_alive_count =  (config->keep_alive_count == 0) ? DEFAULT_KEEP_ALIVE_COUNT : config->keep_alive_count;
        esp_transport_tcp_set_keep_alive(transport, &client->keep_alive_cfg);
    }

Maybe should be interesting to have the keep_alive_enabled just as a boolean and the other configurations as Option<>.
What do you think about this?

}

#[derive(Debug, Copy, Clone, Eq, PartialEq)]
Expand Down Expand Up @@ -138,6 +139,10 @@ impl EspHttpConnection {
native_config.timeout_ms = timeout.as_millis() as _;
}

if let Some(keep_alive_enable) = configuration.keep_alive_enable {
native_config.keep_alive_enable = keep_alive_enable as _;
}

if let (Some(cert), Some(private_key)) =
(configuration.client_certificate, configuration.private_key)
{
Expand Down