ESPHome 2025.5.0
Loading...
Searching...
No Matches
esphome::http_request::HttpRequestIDF Class Reference

#include <http_request_idf.h>

Inheritance diagram for esphome::http_request::HttpRequestIDF:
esphome::http_request::HttpRequestComponent esphome::Component

Public Member Functions

void dump_config () override
 
void set_buffer_size_rx (uint16_t buffer_size_rx)
 
void set_buffer_size_tx (uint16_t buffer_size_tx)
 
- Public Member Functions inherited from esphome::http_request::HttpRequestComponent
float get_setup_priority () const override
 
void set_useragent (const char *useragent)
 
void set_timeout (uint16_t timeout)
 
void set_watchdog_timeout (uint32_t watchdog_timeout)
 
uint32_t get_watchdog_timeout () const
 
void set_follow_redirects (bool follow_redirects)
 
void set_redirect_limit (uint16_t limit)
 
std::shared_ptr< HttpContainerget (const std::string &url)
 
std::shared_ptr< HttpContainerget (const std::string &url, const std::list< Header > &request_headers)
 
std::shared_ptr< HttpContainerget (const std::string &url, const std::list< Header > &request_headers, const std::set< std::string > &collect_headers)
 
std::shared_ptr< HttpContainerpost (const std::string &url, const std::string &body)
 
std::shared_ptr< HttpContainerpost (const std::string &url, const std::string &body, const std::list< Header > &request_headers)
 
std::shared_ptr< HttpContainerpost (const std::string &url, const std::string &body, const std::list< Header > &request_headers, const std::set< std::string > &collect_headers)
 
std::shared_ptr< HttpContainerstart (const std::string &url, const std::string &method, const std::string &body, const std::list< Header > &request_headers)
 
std::shared_ptr< HttpContainerstart (const std::string &url, const std::string &method, const std::string &body, const std::list< Header > &request_headers, const std::set< std::string > &collect_headers)
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen.
 
virtual void loop ()
 This method will be called repeatedly.
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop().
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const char *message)
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages.
 
const char * get_component_source () const
 Get the integration where this component was declared as a string.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 

Protected Member Functions

std::shared_ptr< HttpContainerperform (std::string url, std::string method, std::string body, std::list< Header > request_headers, std::set< std::string > collect_headers) override
 
- Protected Member Functions inherited from esphome::http_request::HttpRequestComponent
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function.
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name.
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function.
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function.
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty.
 

Static Protected Member Functions

static esp_err_t http_event_handler (esp_http_client_event_t *evt)
 Monitors the http client events to gather response headers.
 

Protected Attributes

uint16_t buffer_size_rx_ {}
 
uint16_t buffer_size_tx_ {}
 
- Protected Attributes inherited from esphome::http_request::HttpRequestComponent
const char * useragent_ {nullptr}
 
bool follow_redirects_ {}
 
uint16_t redirect_limit_ {}
 
uint16_t timeout_ {4500}
 
uint32_t watchdog_timeout_ {0}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component.
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 
uint32_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
 
std::string error_message_ {}
 

Detailed Description

Definition at line 32 of file http_request_idf.h.

Member Function Documentation

◆ dump_config()

void esphome::http_request::HttpRequestIDF::dump_config ( )
overridevirtual

Reimplemented from esphome::http_request::HttpRequestComponent.

Definition at line 27 of file http_request_idf.cpp.

◆ http_event_handler()

esp_err_t esphome::http_request::HttpRequestIDF::http_event_handler ( esp_http_client_event_t * evt)
staticprotected

Monitors the http client events to gather response headers.

Definition at line 33 of file http_request_idf.cpp.

◆ perform()

std::shared_ptr< HttpContainer > esphome::http_request::HttpRequestIDF::perform ( std::string url,
std::string method,
std::string body,
std::list< Header > request_headers,
std::set< std::string > collect_headers )
overrideprotectedvirtual

Implements esphome::http_request::HttpRequestComponent.

Definition at line 54 of file http_request_idf.cpp.

◆ set_buffer_size_rx()

void esphome::http_request::HttpRequestIDF::set_buffer_size_rx ( uint16_t buffer_size_rx)
inline

Definition at line 36 of file http_request_idf.h.

◆ set_buffer_size_tx()

void esphome::http_request::HttpRequestIDF::set_buffer_size_tx ( uint16_t buffer_size_tx)
inline

Definition at line 37 of file http_request_idf.h.

Field Documentation

◆ buffer_size_rx_

uint16_t esphome::http_request::HttpRequestIDF::buffer_size_rx_ {}
protected

Definition at line 44 of file http_request_idf.h.

◆ buffer_size_tx_

uint16_t esphome::http_request::HttpRequestIDF::buffer_size_tx_ {}
protected

Definition at line 45 of file http_request_idf.h.


The documentation for this class was generated from the following files: