SensESP 3.0.0-beta.6
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::HTTPAuthenticator Class Referenceabstract

HTTP Authenticator base class. More...

#include <sensesp/net/http_authenticator.h>

Inheritance diagram for sensesp::HTTPAuthenticator:
[legend]

Public Member Functions

 HTTPAuthenticator ()
 
virtual bool authenticate_request (httpd_req_t *req)=0
 Authenticate an incoming request.
 

Detailed Description

HTTP Authenticator base class.

Definition at line 20 of file http_authenticator.h.

Constructor & Destructor Documentation

◆ HTTPAuthenticator()

sensesp::HTTPAuthenticator::HTTPAuthenticator ( )
inline

Definition at line 22 of file http_authenticator.h.

Member Function Documentation

◆ authenticate_request()

virtual bool sensesp::HTTPAuthenticator::authenticate_request ( httpd_req_t * req)
pure virtual

Authenticate an incoming request.

This method should be called at the beginning of each request handler to ensure that the request is authenticated.

Parameters
req
Returns
true Authentication successful.
false Authentication failed.

Implemented in sensesp::HTTPDigestAuthenticator.

Here is the caller graph for this function:

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