#include <http_request.h>

Inheritance diagram for esphome::http_request::HttpRequestComponent:

Public Member Functions
void	dump_config () override

float	get_setup_priority () const override

void	set_url (std::string url)

void	set_method (const char *method)

void	set_useragent (const char *useragent)

void	set_timeout (uint16_t timeout)

void	set_follow_redirects (bool follow_redirects)

void	set_redirect_limit (uint16_t limit)

void	set_body (const std::string &body)

void	set_headers (std::list< Header > headers)

void	send (const std::vector< HttpRequestResponseTrigger *> &response_triggers)

void	close ()

const char *	get_string ()

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 ()

bool	is_ready ()

virtual bool	can_proceed ()

bool	status_has_warning ()

bool	status_has_error ()

void	status_set_warning ()

void	status_set_error ()

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 Member Functions
std::shared_ptr< WiFiClient >	get_wifi_client_ ()

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...

Protected Attributes
HTTPClient	client_ {}

std::string	url_

std::string	last_url_

const char *	method_

const char *	useragent_ {nullptr}

bool	secure_

bool	follow_redirects_

uint16_t	redirect_limit_

uint16_t	timeout_ {5000}

std::string	body_

std::list< Header >	headers_

std::shared_ptr< WiFiClient >	wifi_client_

std::shared_ptr< BearSSL::WiFiClientSecure >	wifi_client_secure_

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}

Detailed Description

Definition at line 39 of file http_request.h.

Member Function Documentation

◆ close()

void esphome::http_request::HttpRequestComponent::close ( )

Definition at line 122 of file http_request.cpp.

◆ dump_config()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 13 of file http_request.cpp.

◆ get_setup_priority()

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

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file http_request.h.

◆ get_string()

const char * esphome::http_request::HttpRequestComponent::get_string ( )

Definition at line 127 of file http_request.cpp.

◆ get_wifi_client_()

std::shared_ptr< WiFiClient > esphome::http_request::HttpRequestComponent::get_wifi_client_ ( )

protected

Definition at line 103 of file http_request.cpp.

◆ send()

void esphome::http_request::HttpRequestComponent::send ( const std::vector< HttpRequestResponseTrigger *> & response_triggers )

Definition at line 33 of file http_request.cpp.

◆ set_body()

void esphome::http_request::HttpRequestComponent::set_body ( const std::string & body )

inline

Definition at line 50 of file http_request.h.

◆ set_follow_redirects()

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

inline

Definition at line 48 of file http_request.h.

◆ set_headers()

void esphome::http_request::HttpRequestComponent::set_headers ( std::list< Header > headers )

inline

Definition at line 51 of file http_request.h.

◆ set_method()

void esphome::http_request::HttpRequestComponent::set_method ( const char * method )

inline

Definition at line 45 of file http_request.h.

◆ set_redirect_limit()

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

inline

Definition at line 49 of file http_request.h.

◆ set_timeout()

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

inline

Definition at line 47 of file http_request.h.

◆ set_url()

void esphome::http_request::HttpRequestComponent::set_url ( std::string url )

Definition at line 21 of file http_request.cpp.

◆ set_useragent()

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

inline

Definition at line 46 of file http_request.h.

Field Documentation

◆ body_

std::string esphome::http_request::HttpRequestComponent::body_

protected

Definition at line 66 of file http_request.h.

◆ client_

HTTPClient esphome::http_request::HttpRequestComponent::client_ {}

protected

Definition at line 57 of file http_request.h.

◆ follow_redirects_

bool esphome::http_request::HttpRequestComponent::follow_redirects_

protected

Definition at line 63 of file http_request.h.

◆ headers_

std::list<Header> esphome::http_request::HttpRequestComponent::headers_

protected

Definition at line 67 of file http_request.h.

◆ last_url_

std::string esphome::http_request::HttpRequestComponent::last_url_

protected

Definition at line 59 of file http_request.h.

◆ method_

const char* esphome::http_request::HttpRequestComponent::method_

protected

Definition at line 60 of file http_request.h.

◆ redirect_limit_

uint16_t esphome::http_request::HttpRequestComponent::redirect_limit_

protected

Definition at line 64 of file http_request.h.

◆ secure_

bool esphome::http_request::HttpRequestComponent::secure_

protected

Definition at line 62 of file http_request.h.

◆ timeout_

uint16_t esphome::http_request::HttpRequestComponent::timeout_ {5000}

protected

Definition at line 65 of file http_request.h.

◆ url_

std::string esphome::http_request::HttpRequestComponent::url_

protected

Definition at line 58 of file http_request.h.

◆ useragent_

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

protected

Definition at line 61 of file http_request.h.

◆ wifi_client_

std::shared_ptr<WiFiClient> esphome::http_request::HttpRequestComponent::wifi_client_

protected

Definition at line 69 of file http_request.h.

◆ wifi_client_secure_

std::shared_ptr<BearSSL::WiFiClientSecure> esphome::http_request::HttpRequestComponent::wifi_client_secure_

protected

Definition at line 71 of file http_request.h.

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

/opt/build/esphome/esphome/components/http_request/http_request.h
/opt/build/esphome/esphome/components/http_request/http_request.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ close()

◆ dump_config()

◆ get_setup_priority()

◆ get_string()

◆ get_wifi_client_()

◆ send()

◆ set_body()

◆ set_follow_redirects()

◆ set_headers()

◆ set_method()

◆ set_redirect_limit()

◆ set_timeout()

◆ set_url()

◆ set_useragent()

Field Documentation

◆ body_

◆ client_

◆ follow_redirects_

◆ headers_

◆ last_url_

◆ method_

◆ redirect_limit_

◆ secure_

◆ timeout_

◆ url_

◆ useragent_

◆ wifi_client_

◆ wifi_client_secure_