ESPHome  2024.11.2
Public Member Functions | Protected Attributes
esphome::http_request::HttpRequestComponent Class Referenceabstract

#include <http_request.h>

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

Public Member Functions

void dump_config () override
 
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 (std::string url)
 
std::shared_ptr< HttpContainerget (std::string url, std::list< Header > headers)
 
std::shared_ptr< HttpContainerpost (std::string url, std::string body)
 
std::shared_ptr< HttpContainerpost (std::string url, std::string body, std::list< Header > headers)
 
virtual std::shared_ptr< HttpContainerstart (std::string url, std::string method, std::string body, std::list< Header > headers)=0
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
virtual void loop ()
 This method will be called repeatedly. More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
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. More...
 
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. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Attributes

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. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Additional Inherited Members

- 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. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
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. More...
 
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. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Detailed Description

Definition at line 110 of file http_request.h.

Member Function Documentation

◆ dump_config()

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

Reimplemented from esphome::Component.

Reimplemented in esphome::http_request::HttpRequestIDF.

Definition at line 12 of file http_request.cpp.

◆ get() [1/2]

std::shared_ptr<HttpContainer> esphome::http_request::HttpRequestComponent::get ( std::string  url)
inline

Definition at line 122 of file http_request.h.

◆ get() [2/2]

std::shared_ptr<HttpContainer> esphome::http_request::HttpRequestComponent::get ( std::string  url,
std::list< Header headers 
)
inline

Definition at line 123 of file http_request.h.

◆ get_setup_priority()

float esphome::http_request::HttpRequestComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 113 of file http_request.h.

◆ get_watchdog_timeout()

uint32_t esphome::http_request::HttpRequestComponent::get_watchdog_timeout ( ) const
inline

Definition at line 118 of file http_request.h.

◆ post() [1/2]

std::shared_ptr<HttpContainer> esphome::http_request::HttpRequestComponent::post ( std::string  url,
std::string  body 
)
inline

Definition at line 126 of file http_request.h.

◆ post() [2/2]

std::shared_ptr<HttpContainer> esphome::http_request::HttpRequestComponent::post ( std::string  url,
std::string  body,
std::list< Header headers 
)
inline

Definition at line 129 of file http_request.h.

◆ set_follow_redirects()

void esphome::http_request::HttpRequestComponent::set_follow_redirects ( bool  follow_redirects)
inline

Definition at line 119 of file http_request.h.

◆ set_redirect_limit()

void esphome::http_request::HttpRequestComponent::set_redirect_limit ( uint16_t  limit)
inline

Definition at line 120 of file http_request.h.

◆ set_timeout()

void esphome::http_request::HttpRequestComponent::set_timeout ( uint16_t  timeout)
inline

Definition at line 116 of file http_request.h.

◆ set_useragent()

void esphome::http_request::HttpRequestComponent::set_useragent ( const char *  useragent)
inline

Definition at line 115 of file http_request.h.

◆ set_watchdog_timeout()

void esphome::http_request::HttpRequestComponent::set_watchdog_timeout ( uint32_t  watchdog_timeout)
inline

Definition at line 117 of file http_request.h.

◆ start()

virtual std::shared_ptr<HttpContainer> esphome::http_request::HttpRequestComponent::start ( std::string  url,
std::string  method,
std::string  body,
std::list< Header headers 
)
pure virtual

Field Documentation

◆ follow_redirects_

bool esphome::http_request::HttpRequestComponent::follow_redirects_ {}
protected

Definition at line 138 of file http_request.h.

◆ redirect_limit_

uint16_t esphome::http_request::HttpRequestComponent::redirect_limit_ {}
protected

Definition at line 139 of file http_request.h.

◆ timeout_

uint16_t esphome::http_request::HttpRequestComponent::timeout_ {4500}
protected

Definition at line 140 of file http_request.h.

◆ useragent_

const char* esphome::http_request::HttpRequestComponent::useragent_ {nullptr}
protected

Definition at line 137 of file http_request.h.

◆ watchdog_timeout_

uint32_t esphome::http_request::HttpRequestComponent::watchdog_timeout_ {0}
protected

Definition at line 141 of file http_request.h.


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