Instances of this class are registered with an HttpServer for a specific URL. More...

#include <HttpResource.h>

Inheritance diagram for HttpResource:
Collaboration diagram for HttpResource:

Classes

class  PluginRef
 

Public Member Functions

virtual ~HttpResource ()
 
virtual void shutdown (HttpServerConnection &connection)
 Takes care to cleanup the connection. More...
 
void addPlugin (HttpResourcePlugin *plugin)
 
template<class... Tail>
void addPlugin (HttpResourcePlugin *plugin, Tail... plugins)
 

Public Attributes

HttpResourceDelegate onUrlComplete = nullptr
 URL is ready. Path and status code are available. More...
 
HttpServerConnectionBodyDelegate onBody = nullptr
 resource wants to process the raw body data More...
 
HttpResourceDelegate onHeadersComplete = nullptr
 headers are ready More...
 
HttpResourceDelegate onRequestComplete = nullptr
 request is complete OR upgraded More...
 
HttpServerConnectionUpgradeDelegate onUpgrade = nullptr
 request is upgraded and raw data is passed to it More...
 

Friends

class HttpServerConnection
 

Detailed Description

Instances of this class are registered with an HttpServer for a specific URL.

Constructor & Destructor Documentation

◆ ~HttpResource()

virtual HttpResource::~HttpResource ( )
inlinevirtual

Member Function Documentation

◆ addPlugin() [1/2]

void HttpResource::addPlugin ( HttpResourcePlugin plugin)

◆ addPlugin() [2/2]

template<class... Tail>
void HttpResource::addPlugin ( HttpResourcePlugin plugin,
Tail...  plugins 
)
inline

◆ shutdown()

virtual void HttpResource::shutdown ( HttpServerConnection connection)
inlinevirtual

Takes care to cleanup the connection.

Reimplemented in HttpMultipartResource, and WebsocketResource.

Friends And Related Function Documentation

◆ HttpServerConnection

friend class HttpServerConnection
friend

Member Data Documentation

◆ onBody

HttpServerConnectionBodyDelegate HttpResource::onBody = nullptr

resource wants to process the raw body data

◆ onHeadersComplete

HttpResourceDelegate HttpResource::onHeadersComplete = nullptr

headers are ready

◆ onRequestComplete

HttpResourceDelegate HttpResource::onRequestComplete = nullptr

request is complete OR upgraded

◆ onUpgrade

HttpServerConnectionUpgradeDelegate HttpResource::onUpgrade = nullptr

request is upgraded and raw data is passed to it

◆ onUrlComplete

HttpResourceDelegate HttpResource::onUrlComplete = nullptr

URL is ready. Path and status code are available.


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