ESPHome 2026.2.3
Loading...
Searching...
No Matches
esphome::http_request::HttpContainerArduino Class Reference

#include <http_request_arduino.h>

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

Public Member Functions

int read (uint8_t *buf, size_t max_len) override
 
void end () override
 
- Public Member Functions inherited from esphome::http_request::HttpContainer
virtual ~HttpContainer ()=default
 
void set_secure (bool secure)
 
void set_chunked (bool chunked)
 
size_t get_bytes_read () const
 
virtual bool is_read_complete () const
 Check if all expected content has been read.
 
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.
 

Protected Member Functions

int read_chunked_ (uint8_t *buf, size_t max_len, WiFiClient *stream)
 Decode chunked transfer encoding from the raw stream.
 
void chunk_header_complete_ ()
 Transition from chunk header to data or trailer based on parsed size.
 

Protected Attributes

HTTPClient client_ {}
 
ChunkedState chunk_state_ {ChunkedState::CHUNK_HEADER}
 
size_t chunk_remaining_ {0}
 Bytes remaining in current chunk.
 
- Protected Attributes inherited from esphome::http_request::HttpContainer
size_t bytes_read_ {0}
 
bool secure_ {false}
 
bool is_chunked_ {false}
 True if response uses chunked transfer encoding.
 
std::map< std::string, std::list< std::string > > response_headers_ {}
 
- Protected Attributes inherited from esphome::Parented< HttpRequestComponent >
HttpRequestComponent * parent_
 

Additional Inherited Members

- Data Fields inherited from esphome::http_request::HttpContainer
size_t content_length {0}
 
int status_code {-1}
 -1 indicates no response received yet
 
uint32_t duration_ms {0}
 

Detailed Description

Definition at line 32 of file http_request_arduino.h.

Member Function Documentation

◆ chunk_header_complete_()

void esphome::http_request::HttpContainerArduino::chunk_header_complete_ ( )
protected

Transition from chunk header to data or trailer based on parsed size.

Definition at line 230 of file http_request_arduino.cpp.

◆ end()

void esphome::http_request::HttpContainerArduino::end ( )
overridevirtual

Implements esphome::http_request::HttpContainer.

Definition at line 367 of file http_request_arduino.cpp.

◆ read()

int esphome::http_request::HttpContainerArduino::read ( uint8_t * buf,
size_t max_len )
overridevirtual

Implements esphome::http_request::HttpContainer.

Definition at line 171 of file http_request_arduino.cpp.

◆ read_chunked_()

int esphome::http_request::HttpContainerArduino::read_chunked_ ( uint8_t * buf,
size_t max_len,
WiFiClient * stream )
protected

Decode chunked transfer encoding from the raw stream.

Definition at line 265 of file http_request_arduino.cpp.

Field Documentation

◆ chunk_remaining_

size_t esphome::http_request::HttpContainerArduino::chunk_remaining_ {0}
protected

Bytes remaining in current chunk.

Definition at line 46 of file http_request_arduino.h.

◆ chunk_state_

ChunkedState esphome::http_request::HttpContainerArduino::chunk_state_ {ChunkedState::CHUNK_HEADER}
protected

Definition at line 45 of file http_request_arduino.h.

◆ client_

HTTPClient esphome::http_request::HttpContainerArduino::client_ {}
protected

Definition at line 39 of file http_request_arduino.h.


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