Arduino互換のTCPクライアント・クラス [詳細]

#include <Ethernet.h>

Public メソッド
bool	connect (byte server[4], unsigned short port)
	サーバに接続する [詳細]

bool	connected ()
	TCPで接続しているかどうか調べる [詳細]

void	stop ()
	TCPで接続していればFINを送って、コネクションを閉じる [詳細]

void	write (unsigned char c)
	接続している相手先に1バイトのデータを送信する [詳細]

void	write (const char *str)
	接続している相手先に文字列を送信する [詳細]

void	write (unsigned char *buf, int len)
	接続している相手先に長さを指定してバイナリデータを送る [詳細]

void	print (int val, int print_type=DEC)
	接続している相手先に型式を指定して、文字列として数値を送る [詳細]

void	print (double val, int fpdigit=2)
	接続している相手先に浮動小数点数を文字列として送る [詳細]

void	print (const char *str)
	接続している相手先に文字列を送る [詳細]

void	println (void)
	接続している相手先に改行コードを送る [詳細]

void	println (int val, int print_type=DEC)
	接続している相手先に型式を指定して、文字列として数値を送り、改行を送る [詳細]

void	println (double val, int fpdigit=2)
	接続している相手先に浮動小数点数を文字列として送り、改行を送る [詳細]

void	println (const char *str)
	接続している相手先に文字列を送り、改行を送る [詳細]

int	available ()
	接続している相手先から受け取ったデータがあるかどうかを調べる [詳細]

int	read ()
	受信したデータを1文字取り出す [詳細]

void	flush ()
	この関数は実装されていない

	operator int ()
	クライアントが存在していたら1。失敗していたら0。

	operator bool ()
	クライアントが存在していたらtrue。失敗していたらfalse。

Static Public メソッド
static unsigned long	getVersion (version_info *vi)
	ライブラリのバージョン情報を取得する [詳細]

説明

Arduino互換のTCPクライアント・クラス

このクラスを使うには、include <Ethernet.h>をした後、EthernetClient client;と書いてインスタンスを作る。

Ethernet.h の 209 行で定義されています。

関数

static unsigned long EthernetClient::getVersion ( version_info * vi )

static

ライブラリのバージョン情報を取得する

引数

[out] vi 拡張情報が必要ならばversion_info構造体へのポインタを与える。
構造体の各フィールドがセットされて戻る。各フィールドは文字列へのポインタだが、
static constな文字列を指すので、ユーザプログラムでfreeしてはならない。
拡張情報が不要ならばNULLを指定してもよい

戻り値: バージョン番号を1バイトずつ詰めた16進数で返す例えば、バージョン1.00ならば、0x01000000を返すバージョン1.23ならば0x010203となる。メジャーバージョン.マイナーバージョン.サブバージョン.デバッグバージョン

bool EthernetClient::connect	(	byte	server[4],
		unsigned short	port
	)

サーバに接続する

引数

[in]	server	接続したいサーバのIPアドレス
[in]	port	接続したいポート番号

戻り値: 成功したらtrueを返す。失敗したらfalseを返す。

覚え書き: この関数は接続に失敗したら自分のポート番号を変えて4回まで試行するので、失敗した分だけサーバにSYN_RCVDが残ってしまう。

bool EthernetClient::connected ( )

TCPで接続しているかどうか調べる

戻り値: 接続していたらtrueを返す。接続していなかったらfalseを返す。

void EthernetClient::stop ( )

TCPで接続していればFINを送って、コネクションを閉じる

戻り値: なし

void EthernetClient::write ( unsigned char c )

接続している相手先に1バイトのデータを送信する

引数

[in] c 送信したいデータ 0x00～0xff

戻り値: なし

void EthernetClient::write ( const char * str )

接続している相手先に文字列を送信する

引数

[in] str 送信したい文字列

戻り値: なし

void EthernetClient::write	(	unsigned char *	buf,
		int	len
	)

接続している相手先に長さを指定してバイナリデータを送る

引数

[in]	buf	送信したいデータが格納されたバッファ
[in]	len	送信したいデータ長

戻り値: なし

void EthernetClient::print	(	int	val,
		int	print_type = `DEC`
	)

接続している相手先に型式を指定して、文字列として数値を送る

引数

[in]	val	送りたい数値
[in]	print_type	BYTE BIN DEC HEX OCT から指定する。

戻り値: なし

void EthernetClient::print	(	double	val,
		int	fpdigit = `2`
	)

接続している相手先に浮動小数点数を文字列として送る

引数

[in]	val	送りたい数値
[in]	fpdigit	小数点以下の桁数

覚え書き: この関数はまだ実装されていない

戻り値: なし

void EthernetClient::print ( const char * str )

接続している相手先に文字列を送る

引数

[in] str 送りたい文字列

戻り値: なし

void EthernetClient::println ( void )

接続している相手先に改行コードを送る

戻り値: なし

void EthernetClient::println	(	int	val,
		int	print_type = `DEC`
	)

接続している相手先に型式を指定して、文字列として数値を送り、改行を送る

引数

[in]	val	送りたい数値
[in]	print_type	BYTE BIN DEC HEX OCT から指定する。

戻り値: なし

void EthernetClient::println	(	double	val,
		int	fpdigit = `2`
	)

接続している相手先に浮動小数点数を文字列として送り、改行を送る

引数

[in]	val	送りたい数値
[in]	fpdigit	小数点以下の桁数

覚え書き: この関数はまだ実装されていない

戻り値: なし

void EthernetClient::println ( const char * str )

接続している相手先に文字列を送り、改行を送る

引数

[in] str 送りたい文字列

戻り値: なし

int EthernetClient::available ( )

接続している相手先から受け取ったデータがあるかどうかを調べる

戻り値: 受信バッファに格納されているデータ数

int EthernetClient::read ( )

受信したデータを1文字取り出す

戻り値: 読み出したデータ。データがなければ-1を返す。

覚え書き: この関数が呼び出されてバッファに空きが生じると、windowサイズの更新のためのACKが送られる

Public メソッド

Static Public メソッド

説明

関数