fsockopen
インターネット接続もしくは Unix ドメインソケット接続をオープンする
説明
resourcefalse fsockopen(
string $hostname,
int $port = -1,
int &$error_code = null,
string &$error_message = null,
floatnull $timeout = null
)
サポートされるソケットトランスポートのリスト に記述されているように、PHP は
Internet ドメインまたは Unix ドメインをサポートします。
サポートされるトランスポートのリストは、stream_get_transports
を使って取得することもできます。
ソケットはデフォルトでブロックモードで開かれます。
socket_set_blocking を使用して、
非ブロックモードに切換えることができます。
stream_socket_client 関数もこれと似ていますがより豊富なオプションを持っており、
非ブロック接続をしたりストリームコンテキストを提供したりする機能があります。
パラメータ
-
hostname
-
OpenSSL サポートが インストール
されている場合、
hostname の前に ssl:// または
tls:// を付加することにより、TCP/IP
経由でリモートホストに接続する際に SSL または
TLS クライアント接続を使用することができます。
-
port
-
ポート番号。
unix:// のようにポートを使わないトランスポートの場合は、
-1 で無視してスキップさせることができます。
-
error_code
-
指定した場合は、システムコール connect()
で発生したエラーのエラー番号が格納されます。
error_code は 0 なのに関数が
false を返す場合、connect()
をコールする前にエラーを発生したことを示します。
この場合、おそらくはソケットの初期化に原因があります。
-
error_message
-
エラーメッセージを表す文字列。
-
timeout
-
接続タイムアウト秒数。
null の場合は、
php.ini の
default_socket_timeout
設定を使います。
注意:
ソケット経由でデータを読み書きする際のタイムアウトを設定する必要がある場合、
fsockopen の timeout パラメータは、
ソケットに接続する間にだけ適用されるため、
socket_set_timeout を使用してください。
戻り値
fsockopenは、ファイルポインタを返します。
このファイルポインタは、
(fgets, fgetss,
fputs, fclose,
feof のような)
他のファイル関数で使用可能です。
失敗した場合は false を返します。
エラー / 例外
hostname が有効なドメインでない場合は
E_WARNING をスローします。
例
例1 fsockopen の例
<?php
$fp = fsockopen("www.example.com", 80, $errno, $errstr, 30);
if (!$fp) {
echo "$errstr ($errno)<br />\n";
} else {
$out = "GET / HTTP/1.1\r\n";
$out .= "Host: www.example.com\r\n";
$out .= "Connection: Close\r\n\r\n";
fwrite($fp, $out);
while (!feof($fp)) {
echo fgets($fp, 128);
}
fclose($fp);
}
?>
例2 UDP 接続の使用法
以下の例は、自分のマシンの UDP サービス "daytime" (ポート13)
から日付と時間を取得する方法を示すものです。
<?php
$fp = fsockopen("udp://127.0.0.1", 13, $errno, $errstr);
if (!$fp) {
echo "ERROR: $errno - $errstr<br />\n";
} else {
fwrite($fp, "\n");
echo fread($fp, 26);
fclose($fp);
}
?>
注意
注意:
環境によっては Unix ドメインまたは
オプションの接続タイムアウトが利用できないこともあります。
警告
UDPソケットは、リモートホストとの接続が確立されていない場合でも、
エラーを発生せずにオープンされたように見えることが時々あります。
このエラーは、そのソケットでデータを読み書きした際にのみ明らかになります。
この原因は、UDPが"コネクションレス"のプロトコルであり、
実際にデータを送受信する必要が生じるまで、
オペレーションシステムがソケット用のリンクを確立しようとしないためです。
注意: 数値で IPv6 アドレスを指定するときは、
(例 fe80::1) アドレスを角カッコでくくらなくてはなりません。たとえば、
tcp://[fe80::1]:80.
参考
- pfsockopen
- stream_socket_client
- stream_set_blocking
- stream_set_timeout
- fgets
- fgetss
- fwrite
- fclose
- feof
- socket_connect
- Curl 拡張モジュール