WiFiClient の解説と実装リファレンス

この記事の目次

【概要】
【仕様】
1. 主要メソッド
2. データ型
【技術的特徴】
1. 比較：WiFiClient vs WiFiBearSSLClient
【注意点】
【サンプルコード】
【活用例】

【概要】

WiFiClient は、Arduino WiFiライブラリにおいてTCPクライアント接続を管理するためのクラスです。このクラスは、リモートサーバーへのTCP接続の確立、データの送信、および受信の処理を抽象化し、SerialやEthernetClientと同様のストリームインターフェースを提供します。

TCP（Transmission Control Protocol）プロトコルに基づき、接続の確立（3ウェイ・ハンドシェイク）、パケットの順序保証、再送制御、およびフロー制御を基盤層（ESP8266/ESP32 SDK等）に委ねながら、アプリケーション層からのデータ入出力を提供します。

【仕様】

WiFiClient クラスは、以下の主要なメソッドと特性を持ちます。

主要メソッド

bool connect(const char* host, uint16_t port): 指定したホスト名またはIPアドレスおよびポート番号に対してTCP接続を試行します。接続成功時にtrueを返します。
int available(): 受信バッファ内に読み取り可能なバイト数がある場合にその数を返し、なければ0を返します。
int read(): 受信バッファから1バイト読み取り、値を返します。データがない場合は-1を返します。
int write(const uint8_t* str, size_t len): データを送信バッファに書き込み、送信処理を開始します。
int flush(): 送信バッファ内のすべてのデータが送信されるまで待機します。
void close(): 現在のTCP接続を破棄し、切断します。
unsigned long timeout(unsigned long ms): 通信操作のタイムアウト時間をミリ秒単位で設定します。

データ型

Host: const char* または IPAddress 型
Port: uint16_t 型
Read/Write: uint8_t (byte), int, String 型に対応

【技術的特徴】

ストリーム抽象化: Serialクラスと同様のインターフェースを採用しているため、既存のシリアル通信用ライブラリを最小限の修正でTCP通信に転用可能です。
ブロック動作と非同期処理: connect() や write() はデフォルトでブロッキング動作（同期処理）を行う設計ですが、内部的なバッファリングにより、短時間の書き込みは即座に完了します。
TCPスタックへの依存: WiFiClient 自体はデータの転送のみを管理し、実際の再送制御やウィンドウサイズ調整は、ハードウェア/OS層のTCPスタック（LwIP等）によって実行されます。

比較：WiFiClient vs WiFiBearSSLClient

WiFiClient: 暗号化されていない生のTCP通信を行います。オーバーヘッドが少なく高速ですが、セキュリティは確保されません。
WiFiBearSSLClient: TLS/SSLによる暗号化通信を行います。ハンドシェイク処理や暗号化処理が必要なため、メモリ消費量と計算負荷が大幅に増加します。

【注意点】

ブロッキングによる影響: connect() 関数は接続が確立されるかタイムアウトするまでプログラムの実行を停止します。Webリクエストの送信時などにメインループを停止させないよう、適切なタイムアウト設定が必要です。
バッファサイズ制限: 受信バッファには上限があり、大きなデータ（例：数KB以上の画像データ等）を一度に受信しようとすると、バッファ溢れや遅延が発生する可能性があります。チャンク単位での読み取り処理が推奨されます。
メモリ消費: クライアントオブジェクトの生成はヒープまたはスタックメモリを消費します。多数の同時接続を試みる場合、メモリ不足に注意が必要です。
タイムアウト設定: デフォルトのタイムアウトが長い場合、ネットワークの切断時にアプリケーションがフリーズしたように見えることがあります。timeout() 関数での適切な管理が必須です。

【サンプルコード】

以下は、指定されたIPアドレスのサーバーに接続し、メッセージを送信する基本的な実装例です。

#include <WiFi.h>

const char* ssid = "YOUR_SSID";
const char* password = "YOUR_PASSWORD";
const char* server_ip = "192.168.1.100";
const uint16_t server_port = 8080;

WiFiClient client;

void setup() {
  Serial.begin(115200);
  WiFi.begin(ssid, password);
  while (WiFi.status() != WL_CONNECTED) {
    delay(500);
    Serial.print(".");
  }
  Serial.println("Connected to WiFi");
}

void loop() {
  if (!client.connected()) {
    Serial.println("Connecting to server...");
    if (client.connect(server_ip, server_port)) {
      Serial.println("Connected!");
      client.println("Hello from Arduino Client");
      client.flush();
      client.close();
    } else {
      Serial.println("Connection failed");
      delay(5000); // 再試行までの待機
    }
  }
  delay(10000); // 10秒ごとに再接続を試行
}

【活用例】

MQTTプロトコルへの接続: MQTTクライアントライブラリの内部では、WiFiClient をベースとしてTCP接続を構築しています。
簡易的なHTTPリクエスト: HTTPClient ライブラリを使用せずに、直接 WiFiClient を用いて GET リクエストを構築し、サーバーからレスポンスを解析する。
独自プロトコルによるテレメトリ送信: 独自のバイナリプロトコルを設計し、センサーデータを効率的にサーバーへ転送するシステムの構築。