fsockopen.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4e6f0774f03131cbeeb8c21019a690bf97fd22b6 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,mumumu -->
<refentry xml:id="function.fsockopen" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fsockopen</refname>
  <refpurpose>インターネット接続もしくは Unix ドメインソケット接続をオープンする</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>resource</type><type>false</type></type><methodname>fsockopen</methodname>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">error_code</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">error_message</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>float</type><type>null</type></type><parameter>timeout</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>hostname</parameter> で指定したリソースへのソケット接続を開始します。
  </para>
  <para>
   <xref linkend="transports"/> に記述されているように、PHP は
   Internet ドメインまたは Unix ドメインをサポートします。
   サポートされるトランスポートのリストは、<function>stream_get_transports</function>
   を使って取得することもできます。
  </para>
  <para>
   ソケットはデフォルトでブロックモードで開かれます。
   <function>socket_set_blocking</function> を使用して、
   非ブロックモードに切換えることができます。
  </para>
  <para>
   <function>stream_socket_client</function> 関数もこれと似ていますがより豊富なオプションを持っており、
   非ブロック接続をしたりストリームコンテキストを提供したりする機能があります。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       OpenSSL サポートが <link linkend="openssl.installation">インストール</link>
       されている場合、
       <parameter>hostname</parameter> の前に <literal>ssl://</literal> または
       <literal>tls://</literal> を付加することにより、TCP/IP
       経由でリモートホストに接続する際に SSL または
       TLS クライアント接続を使用することができます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       ポート番号。
       <literal>unix://</literal> のようにポートを使わないトランスポートの場合は、
       <literal>-1</literal> で無視してスキップさせることができます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error_code</parameter></term>
     <listitem>
      <para>
       指定した場合は、システムコール <literal>connect()</literal>
       で発生したエラーのエラー番号が格納されます。
      </para>
      <para>
       <parameter>error_code</parameter> は <literal>0</literal> なのに関数が
       &false; を返す場合、<literal>connect()</literal>
       をコールする前にエラーを発生したことを示します。
       この場合、おそらくはソケットの初期化に原因があります。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error_message</parameter></term>
     <listitem>
      <para>
       エラーメッセージを表す文字列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>timeout</parameter></term>
     <listitem>
      <para>
       接続タイムアウト秒数。
       &null; の場合は、
       &php.ini; の
       <link linkend="ini.default-socket-timeout">default_socket_timeout</link>
       設定を使います。
      </para>
      <note>
       <para>
        ソケット経由でデータを読み書きする際のタイムアウトを設定する必要がある場合、
        <function>fsockopen</function> の <parameter>timeout</parameter> パラメータは、
        ソケットに接続する間にだけ適用されるため、
        <function>socket_set_timeout</function> を使用してください。
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>fsockopen</function>は、ファイルポインタを返します。
   このファイルポインタは、
   (<function>fgets</function>, <function>fgetss</function>,
   <function>fputs</function>, <function>fclose</function>,
   <function>feof</function> のような)
   他のファイル関数で使用可能です。
   失敗した場合は &false; を返します。
  </para>
 </refsect1>
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>hostname</parameter> が有効なドメインでない場合は
   <constant>E_WARNING</constant> をスローします。
  </para>
 </refsect1>

 <refsect1 role="changelog"><!-- {{{ -->
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>timeout</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>fsockopen</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?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);
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>UDP 接続の使用法</title>
    <para>
     以下の例は、自分のマシンの UDP サービス "daytime" (ポート13)
     から日付と時間を取得する方法を示すものです。
    </para>
    <programlisting role="php">
<![CDATA[
<?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);
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    環境によっては Unix ドメインまたは
    オプションの接続タイムアウトが利用できないこともあります。
   </para>
  </note>
  <warning>
   <para>
    UDPソケットは、リモートホストとの接続が確立されていない場合でも、
    エラーを発生せずにオープンされたように見えることが時々あります。
    このエラーは、そのソケットでデータを読み書きした際にのみ明らかになります。
    この原因は、UDPが"コネクションレス"のプロトコルであり、
    実際にデータを送受信する必要が生じるまで、
    オペレーションシステムがソケット用のリンクを確立しようとしないためです。
   </para>
  </warning>
  &ipv6.brackets;
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pfsockopen</function></member>
    <member><function>stream_socket_client</function></member>
    <member><function>stream_set_blocking</function></member>
    <member><function>stream_set_timeout</function></member>
    <member><function>fgets</function></member>
    <member><function>fgetss</function></member>
    <member><function>fwrite</function></member>
    <member><function>fclose</function></member>
    <member><function>feof</function></member>
    <member><function>socket_connect</function></member>
    <member><link linkend="ref.curl">Curl 拡張モジュール</link></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->