説明

UDPメッセージを送受信できるWiFiUDPクラスの名前付きインスタンスを作成する。AVRベースのボードでは、現在、送信するUDPパケットのサイズは72バイトに制限される。AVRボード以外のボードでは、制限は1446バイトである。

書式

WiFiUDP

引数

戻り値

なし。

説明

WiFiUDPライブラリとネットワーク設定を初期化する。WiFiUDPソケットを開始し、ローカルポートを待ち受ける。

書式

WiFiUDP.begin(port);

引数

戻り値

説明

バッファから読み込み可能な文字数を取得する。これは、既に到着しているデータである。

この関数は、WiFiUDP.parsePacket()の後に呼び出したときにだけ成功する。

available()は、はStreamクラスを継承している。

書式

WiFiUDP.available();

引数

なし。

戻り値

現在のパケットで利用可能なバイト数。parsePacket()呼び出し前のときは0。

説明

リモート接続に対し、UDPデータを送信するための接続を開始する。

書式

WiFiUDP.beginPacket(hostName, port);

WiFiUDP.beginPacket(hostIp, port);

引数

戻り値

説明

リモート接続に対しUDPデータを送信した後に呼ぶ。パケットを終了し送信する。

書式

WiFiUDP.endPacket();;

引数

なし。

戻り値

説明

リモート接続に対しUDPデータを送信する。beginPacket()とendPacket()の間に呼び出す必要がある。beginPacket()はデータのパケットを初期化し、endPacket()が呼び出されるまでデータは送信されない。

書式

WiFiUDP.write(byte);

WiFiUDP.write(buffer, size);

引数

戻り値

送信したバイト数

説明

受信した利用可能なパケットの処理を開始する。UDPパケットの存在を確認し、サイズを返す。parsePacket()はUDP.read()でバッファを呼ぶ前に呼び出す必要がある。

書式

UDP.parsePacket();

引数

なし。

戻り値

パケットのサイズ。パケットがない場合は0。

説明

バッファを保持したまま、バッファから1バイト受信する。すなわち、次のpeek()も同じ値を読む。read()は次の値を読む。

この関数は、Streamクラスを継承している。詳細はStreamクラスを参照すること。

書式

WiFiUDP.peek();

引数

なし。

戻り値

次のバイトもしくは文字。利用可能でない場合は-1。

説明

指定したバッファにUDPデータを読み込む。引数がない場合は、バッファ内の次の文字を返す。

この関数は、WiFiUDP.parsePacket()の後に呼び出したときにだけ成功する。

書式

WiFiUDP.read();

WiFiUDP.read(buffer, len);

引数

戻り値

受信した文字。受信したバッファのサイズ。バッファが利用できないときは-1。

説明

クライアントに送信したが受信されていないデータを破棄する。引数がない場合は、バッファ内の次の文字を返す。

flush()は、Streamクラスを継承している。

書式

WiFiUDP.flush();

引数

なし。

戻り値

なし。

説明

サーバーから切り離す。UDPセッションの間利用されたすべての資源を解放する。

書式

WiFiUDP.stop();

引数

なし。

戻り値

なし。

説明

リモート接続のIPアドレスを取得する。

この関数はWiFiUDP.parsePacket()を呼び出した後に呼び出す必要がある。

書式

WiFiUDP.remoteIP();

引数

なし。

戻り値

現在のパケットを送信したホストのIPアドレス(4バイト)。

説明

リモート接続のポートを取得する。

この関数はWiFiUDP.parsePacket()を呼び出した後に呼び出す必要がある。

書式

WiFiUDP.remotePort();

引数

なし。

戻り値

現在のパケットを送信したホストのポート。