HttpResourceTree Class Reference
Class to map URL paths to classes which handle them. More...
#include <HttpResourceTree.h>
Inheritance diagram for HttpResourceTree:
Collaboration diagram for HttpResourceTree:
Public Member Functions | |
HttpResource * | setDefault (HttpResource *resource) |
Set the default resource handler. More... | |
HttpResource * | setDefault (const HttpResourceDelegate &onRequestComplete) |
Set the default resource handler, identified by "*" wildcard. More... | |
HttpResource * | setDefault (const HttpPathDelegate &callback) |
Set the default resource handler, identified by "*" wildcard. More... | |
HttpResource * | getDefault () |
Get the current default resource handler, if any. More... | |
template<class... Tail> | |
HttpResource * | set (const String &path, HttpResource *resource, HttpResourcePlugin *plugin, Tail... plugins) |
HttpResource * | set (const String &path, const HttpResourceDelegate &onRequestComplete) |
Set a callback to handle the given path. More... | |
template<class... Tail> | |
HttpResource * | set (const String &path, const HttpResourceDelegate &onRequestComplete, HttpResourcePlugin *plugin, Tail... plugins) |
Set a callback to handle the given path, with one or more plugins. More... | |
HttpResource * | set (String path, const HttpPathDelegate &callback) |
Add a new path resource with a callback. More... | |
template<class... Tail> | |
HttpResource * | set (const String &path, const HttpPathDelegate &callback, HttpResourcePlugin *plugin, Tail... plugins) |
Add a new path resource with callback and one or more plugins. More... | |
void | set (const K &key, V *value) |
Set a key value. More... | |
![]() | |
ObjectMap () | |
~ObjectMap () | |
unsigned | count () const |
Get the number of entries in this map. More... | |
const String & | keyAt (unsigned idx) const |
String & | keyAt (unsigned idx) |
const HttpResource * | valueAt (unsigned idx) const |
Value | valueAt (unsigned idx) |
const HttpResource * | operator[] (const String &key) const |
Get value for given key, if it exists. More... | |
Value | operator[] (const String &key) |
Access map entry by reference. More... | |
Value | get (const String &key) |
Get map entry value. More... | |
void | set (const String &key, HttpResource *value) |
Set a key value. More... | |
HttpResource * | find (const String &key) const |
Find the value for a given key, if it exists. More... | |
int | indexOf (const String &key) const |
Get the index of a key. More... | |
bool | contains (const String &key) const |
Check if a key is contained within this map. More... | |
void | removeAt (unsigned index) |
Remove entry at given index. More... | |
bool | remove (const String &key) |
Remove a key from this map. More... | |
HttpResource * | extract (const String &key) |
Get the value for a given key and remove it from the map, without destroying it. More... | |
HttpResource * | extractAt (unsigned index) |
Get the value at a given index and remove it from the map, without destroying it. More... | |
void | clear () |
Clear the map of all entries. More... | |
Additional Inherited Members | |
![]() | |
Vector< Entry > | entries |
Detailed Description
Class to map URL paths to classes which handle them.
Member Function Documentation
◆ getDefault()
|
inline |
Get the current default resource handler, if any.
- Return values
-
HttpResource*
◆ set() [1/6]
|
inline |
Set a key value.
- Parameters
-
key value
◆ set() [2/6]
template<class... Tail>
|
inline |
Add a new path resource with callback and one or more plugins.
- Parameters
-
path URL path callback The callback that will handle this path plugin - optional resource plugin
- Return values
-
HttpResource* The created resource object
- Note
- Path should start with slash. Trailing slashes will be removed
- Any existing handler for this path is replaced
◆ set() [3/6]
HttpResource* HttpResourceTree::set | ( | const String & | path, |
const HttpResourceDelegate & | onRequestComplete | ||
) |
Set a callback to handle the given path.
- Parameters
-
path URL path onRequestComplete Delegate to handle this path
- Return values
-
HttpResource* The created resource object
- Note
- Path should start with slash. Trailing slashes will be removed.
- Any existing handler for this path is replaced
◆ set() [4/6]
template<class... Tail>
|
inline |
Set a callback to handle the given path, with one or more plugins.
- Parameters
-
path URL path onRequestComplete Delegate to handle this path plugin Plugins to register for the resource
- Return values
-
HttpResource* The created resource object
- Note
- Path should start with slash. Trailing slashes will be removed.
- Any existing handler for this path is replaced
◆ set() [5/6]
template<class... Tail>
|
inline |
◆ set() [6/6]
HttpResource* HttpResourceTree::set | ( | String | path, |
const HttpPathDelegate & | callback | ||
) |
Add a new path resource with a callback.
- Parameters
-
path URL path callback The callback that will handle this path
- Note
- Path should start with slash. Trailing slashes will be removed
- Any existing handler for this path is replaced
◆ setDefault() [1/3]
|
inline |
Set the default resource handler, identified by "*" wildcard.
◆ setDefault() [2/3]
|
inline |
Set the default resource handler, identified by "*" wildcard.
- Parameters
-
onRequestComplete The default resource handler
◆ setDefault() [3/3]
|
inline |
Set the default resource handler.
- Parameters
-
resource The default resource handler
The documentation for this class was generated from the following file: