ESPHome 2026.2.4
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
esphome::web_server_idf::AsyncWebServerRequest Class Reference

#include <web_server_idf.h>

Public Member Functions

 ~AsyncWebServerRequest ()
 
http_method method () const
 
StringRef url_to (std::span< char, URL_BUF_SIZE > buffer) const
 Write URL (without query string) to buffer, returns StringRef pointing to buffer.
 
std::string url () const
 Get URL as std::string. Prefer url_to() to avoid heap allocation.
 
size_t contentLength () const
 
bool authenticate (const char *username, const char *password) const
 
void requestAuthentication (const char *realm=nullptr) const
 
void redirect (const std::string &url)
 
void send (AsyncWebServerResponse *response)
 
void send (int code, const char *content_type=nullptr, const char *content=nullptr)
 
AsyncWebServerResponse * beginResponse (int code, const char *content_type)
 
AsyncWebServerResponse * beginResponse (int code, const char *content_type, const std::string &content)
 
AsyncWebServerResponse * beginResponse (int code, const char *content_type, const uint8_t *data, const size_t data_size)
 
AsyncResponseStream * beginResponseStream (const char *content_type)
 
bool hasParam (const char *name)
 
bool hasParam (const std::string &name)
 
AsyncWebParameter * getParam (const char *name)
 
AsyncWebParameter * getParam (const std::string &name)
 
bool hasArg (const char *name)
 
std::string arg (const char *name)
 
std::string arg (const std::string &name)
 
 operator httpd_req_t * () const
 
optional< std::string > get_header (const char *name) const
 
bool hasHeader (const char *name) const
 

Static Public Attributes

static constexpr size_t URL_BUF_SIZE = CONFIG_HTTPD_MAX_URI_LEN + 1
 Buffer size for url_to()
 

Protected Member Functions

 AsyncWebServerRequest (httpd_req_t *req)
 
 AsyncWebServerRequest (httpd_req_t *req, std::string post_query)
 
void init_response_ (AsyncWebServerResponse *rsp, int code, const char *content_type)
 

Protected Attributes

httpd_req_t * req_
 
AsyncWebServerResponse * rsp_ {}
 
std::vector< AsyncWebParameter * > params_
 
std::string post_query_
 

Detailed Description

Definition at line 108 of file web_server_idf.h.

Constructor & Destructor Documentation

◆ ~AsyncWebServerRequest()

esphome::web_server_idf::AsyncWebServerRequest::~AsyncWebServerRequest ( )

Definition at line 236 of file web_server_idf.cpp.

◆ AsyncWebServerRequest() [1/2]

esphome::web_server_idf::AsyncWebServerRequest::AsyncWebServerRequest ( httpd_req_t * req)
inlineprotected

Definition at line 197 of file web_server_idf.h.

◆ AsyncWebServerRequest() [2/2]

esphome::web_server_idf::AsyncWebServerRequest::AsyncWebServerRequest ( httpd_req_t * req,
std::string post_query )
inlineprotected

Definition at line 198 of file web_server_idf.h.

Member Function Documentation

◆ arg() [1/2]

std::string esphome::web_server_idf::AsyncWebServerRequest::arg ( const char * name)
inline

Definition at line 174 of file web_server_idf.h.

◆ arg() [2/2]

std::string esphome::web_server_idf::AsyncWebServerRequest::arg ( const std::string & name)
inline

Definition at line 181 of file web_server_idf.h.

◆ authenticate()

bool esphome::web_server_idf::AsyncWebServerRequest::authenticate ( const char * username,
const char * password ) const

Definition at line 314 of file web_server_idf.cpp.

◆ beginResponse() [1/3]

AsyncWebServerResponse * esphome::web_server_idf::AsyncWebServerRequest::beginResponse ( int code,
const char * content_type )
inline

Definition at line 138 of file web_server_idf.h.

◆ beginResponse() [2/3]

AsyncWebServerResponse * esphome::web_server_idf::AsyncWebServerRequest::beginResponse ( int code,
const char * content_type,
const std::string & content )
inline

Definition at line 144 of file web_server_idf.h.

◆ beginResponse() [3/3]

AsyncWebServerResponse * esphome::web_server_idf::AsyncWebServerRequest::beginResponse ( int code,
const char * content_type,
const uint8_t * data,
const size_t data_size )
inline

Definition at line 150 of file web_server_idf.h.

◆ beginResponseStream()

AsyncResponseStream * esphome::web_server_idf::AsyncWebServerRequest::beginResponseStream ( const char * content_type)
inline

Definition at line 157 of file web_server_idf.h.

◆ contentLength()

size_t esphome::web_server_idf::AsyncWebServerRequest::contentLength ( ) const
inline

Definition at line 125 of file web_server_idf.h.

◆ get_header()

optional< std::string > esphome::web_server_idf::AsyncWebServerRequest::get_header ( const char * name) const

Definition at line 245 of file web_server_idf.cpp.

◆ getParam() [1/2]

AsyncWebParameter * esphome::web_server_idf::AsyncWebServerRequest::getParam ( const char * name)

Definition at line 387 of file web_server_idf.cpp.

◆ getParam() [2/2]

AsyncWebParameter * esphome::web_server_idf::AsyncWebServerRequest::getParam ( const std::string & name)
inline

Definition at line 170 of file web_server_idf.h.

◆ hasArg()

bool esphome::web_server_idf::AsyncWebServerRequest::hasArg ( const char * name)
inline

Definition at line 173 of file web_server_idf.h.

◆ hasHeader()

bool esphome::web_server_idf::AsyncWebServerRequest::hasHeader ( const char * name) const

Definition at line 243 of file web_server_idf.cpp.

◆ hasParam() [1/2]

bool esphome::web_server_idf::AsyncWebServerRequest::hasParam ( const char * name)
inline

Definition at line 164 of file web_server_idf.h.

◆ hasParam() [2/2]

bool esphome::web_server_idf::AsyncWebServerRequest::hasParam ( const std::string & name)
inline

Definition at line 166 of file web_server_idf.h.

◆ init_response_()

void esphome::web_server_idf::AsyncWebServerRequest::init_response_ ( AsyncWebServerResponse * rsp,
int code,
const char * content_type )
protected

Definition at line 281 of file web_server_idf.cpp.

◆ method()

http_method esphome::web_server_idf::AsyncWebServerRequest::method ( ) const
inline

Definition at line 114 of file web_server_idf.h.

◆ operator httpd_req_t *()

esphome::web_server_idf::AsyncWebServerRequest::operator httpd_req_t * ( ) const
inline

Definition at line 183 of file web_server_idf.h.

◆ redirect()

void esphome::web_server_idf::AsyncWebServerRequest::redirect ( const std::string & url)

Definition at line 274 of file web_server_idf.cpp.

◆ requestAuthentication()

void esphome::web_server_idf::AsyncWebServerRequest::requestAuthentication ( const char * realm = nullptr) const

Definition at line 378 of file web_server_idf.cpp.

◆ send() [1/2]

void esphome::web_server_idf::AsyncWebServerRequest::send ( AsyncWebServerResponse * response)

Definition at line 261 of file web_server_idf.cpp.

◆ send() [2/2]

void esphome::web_server_idf::AsyncWebServerRequest::send ( int code,
const char * content_type = nullptr,
const char * content = nullptr )

Definition at line 265 of file web_server_idf.cpp.

◆ url()

std::string esphome::web_server_idf::AsyncWebServerRequest::url ( ) const
inline

Get URL as std::string. Prefer url_to() to avoid heap allocation.

Definition at line 120 of file web_server_idf.h.

◆ url_to()

StringRef esphome::web_server_idf::AsyncWebServerRequest::url_to ( std::span< char, URL_BUF_SIZE > buffer) const

Write URL (without query string) to buffer, returns StringRef pointing to buffer.

URL is decoded (e.g., %20 -> space).

Definition at line 249 of file web_server_idf.cpp.

Field Documentation

◆ params_

std::vector<AsyncWebParameter *> esphome::web_server_idf::AsyncWebServerRequest::params_
protected

Definition at line 195 of file web_server_idf.h.

◆ post_query_

std::string esphome::web_server_idf::AsyncWebServerRequest::post_query_
protected

Definition at line 196 of file web_server_idf.h.

◆ req_

httpd_req_t* esphome::web_server_idf::AsyncWebServerRequest::req_
protected

Definition at line 189 of file web_server_idf.h.

◆ rsp_

AsyncWebServerResponse* esphome::web_server_idf::AsyncWebServerRequest::rsp_ {}
protected

Definition at line 190 of file web_server_idf.h.

◆ URL_BUF_SIZE

size_t esphome::web_server_idf::AsyncWebServerRequest::URL_BUF_SIZE = CONFIG_HTTPD_MAX_URI_LEN + 1
staticconstexpr

Buffer size for url_to()

Definition at line 115 of file web_server_idf.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.12.0