HTTPClient::begin()

名称

HTTPClient::begin()

説明

アクセスするURLを登録する。

HTTPSを利用する場合は、(必要ならば)ルート証明書も登録する。

このAPIでURLを登録した後、GET()/PATCH()/POST()/PUTなどを呼び出すことで、実際にデータの送受信が行われる。

#include <HTTPClient.h>

bool HTTPClient::begin(WiFiClient &client, String url);

bool HTTPClient::begin(WiFiClient &client, String host, uint16_t port, String uri, bool https);

以下は、HTTPCLIENT_1_1_COMPATIBLEが定義されている場合有効(デフォルトでは定義されている)。

bool HTTPClient::begin(String url);

bool HTTPClient::begin(String url, const char* CAcert);

bool HTTPClient::begin(String host, uint16_t port, String uri = "/");

bool HTTPClient::begin(String host, uint16_t port, String uri, const char* CAcert);

`client`	WiFiClient オブジェクト。
`url`	アクセスしたいURL。
`uri`	アクセスしたいURI(ここでは、URLからスキームとオーソリティを除いたもののようです)。
`host`	アクセスしたいホスト。
`port`	アクセスしたいホストのポート。
`https`	プロトコル。trueの場合 https, false の場合 http。
`CAcert`	アクセスしたいURLの、ルート証明書。Base64形式で指定する。

登録結果。成功した場合は、true。失敗した場合は、false。

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

September 4, 2022