WebServer::on()

名称

WebServer::on()

説明

指定したURIにアクセスがあった時に呼び出す関数を登録する。

書式

#include <WebServer.h>

void WebServer::on(const Uri &uri, THandlerFunction fn);

void WebServer::on(const Uri &uri, HTTPMethod method, THandlerFunction fn);

void WebServer::on(const Uri &uri, HTTPMethod method, THandlerFunction fn, THandlerFunction ufn);

void WebServer::on(const Uri &uri, WebServer::THandlerFunction handler);

void WebServer::on(const Uri &uri, HTTPMethod method, WebServer::THandlerFunction fn);

void WebServer::on(const Uri &uri, HTTPMethod method, WebServer::THandlerFunction fn, WebServer::THandlerFunction ufn);

引数

uri URI。
fn 呼び出す関数。
method メソッド。1番目の書式の場合、HTTP_ANYが設定される。
ufn POSTメソッド実行時、リクエストボディ受信中に呼び出される関数。

HTTPMethod型は、以下の通り。

typedef enum {
  HTTP_GET     = 0b00000001,
  HTTP_POST    = 0b00000010,
  HTTP_DELETE  = 0b00000100,
  HTTP_PUT     = 0b00001000,
  HTTP_PATCH   = 0b00010000,
  HTTP_HEAD    = 0b00100000,
  HTTP_OPTIONS = 0b01000000,
  HTTP_ANY     = 0b01111111,
} HTTPMethod;

また、THandlerFunctionは以下のように定義されている。

typedef std::function<void(void)> THandlerFunction;

戻り値

なし。

使用例

バージョン

Hardware:ESP-WROOM-32
Software:Arduino core for the ESP32 2.0.4

最終更新日

September 4, 2022

inserted by FC2 system