ESPHome 2025.5.0
Loading...
Searching...
No Matches
esphome::http_request::HttpContainer Class Referenceabstract

#include <http_request.h>

Inheritance diagram for esphome::http_request::HttpContainer:
esphome::Parented< HttpRequestComponent > esphome::http_request::HttpContainerArduino esphome::http_request::HttpContainerHost esphome::http_request::HttpContainerIDF

Public Member Functions

virtual ~HttpContainer ()=default
 
virtual int read (uint8_t *buf, size_t max_len)=0
 
virtual void end ()=0
 
void set_secure (bool secure)
 
size_t get_bytes_read () const
 
std::map< std::string, std::list< std::string > > get_response_headers ()
 Get response headers.
 
std::string get_response_header (const std::string &header_name)
 
- Public Member Functions inherited from esphome::Parented< HttpRequestComponent >
 Parented ()
 
 Parented (HttpRequestComponent *parent)
 
HttpRequestComponent * get_parent () const
 Get the parent of this object.
 
void set_parent (HttpRequestComponent *parent)
 Set the parent of this object.
 

Data Fields

size_t content_length
 
int status_code
 
uint32_t duration_ms
 

Protected Attributes

size_t bytes_read_ {0}
 
bool secure_ {false}
 
std::map< std::string, std::list< std::string > > response_headers_ {}
 
- Protected Attributes inherited from esphome::Parented< HttpRequestComponent >
HttpRequestComponent * parent_
 

Detailed Description

Definition at line 85 of file http_request.h.

Constructor & Destructor Documentation

◆ ~HttpContainer()

virtual esphome::http_request::HttpContainer::~HttpContainer ( )
virtualdefault

Member Function Documentation

◆ end()

virtual void esphome::http_request::HttpContainer::end ( )
pure virtual

◆ get_bytes_read()

size_t esphome::http_request::HttpContainer::get_bytes_read ( ) const
inline

Definition at line 97 of file http_request.h.

◆ get_response_header()

std::string esphome::http_request::HttpContainer::get_response_header ( const std::string & header_name)

Definition at line 23 of file http_request.cpp.

◆ get_response_headers()

std::map< std::string, std::list< std::string > > esphome::http_request::HttpContainer::get_response_headers ( )
inline

Get response headers.

Returns
The key is the lower case response header name, the value is the header value.

Definition at line 104 of file http_request.h.

◆ read()

virtual int esphome::http_request::HttpContainer::read ( uint8_t * buf,
size_t max_len )
pure virtual

◆ set_secure()

void esphome::http_request::HttpContainer::set_secure ( bool secure)
inline

Definition at line 95 of file http_request.h.

Field Documentation

◆ bytes_read_

size_t esphome::http_request::HttpContainer::bytes_read_ {0}
protected

Definition at line 109 of file http_request.h.

◆ content_length

size_t esphome::http_request::HttpContainer::content_length

Definition at line 88 of file http_request.h.

◆ duration_ms

uint32_t esphome::http_request::HttpContainer::duration_ms

Definition at line 90 of file http_request.h.

◆ response_headers_

std::map<std::string, std::list<std::string> > esphome::http_request::HttpContainer::response_headers_ {}
protected

Definition at line 111 of file http_request.h.

◆ secure_

bool esphome::http_request::HttpContainer::secure_ {false}
protected

Definition at line 110 of file http_request.h.

◆ status_code

int esphome::http_request::HttpContainer::status_code

Definition at line 89 of file http_request.h.


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