socket.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8bc832a464e33122e8129f5a623bd845b69fa7e0 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->

<refentry xml:id="context.socket" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" annotations="verify_info:false" role="stream_context_option">
 <refnamediv>
  <refname>ソケットコンテキストオプション</refname>
  <refpurpose>ソケットコンテキストオプション一覧</refpurpose>
 </refnamediv>
 
 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <para>
   ここでは、ソケット越しに動作するラッパー
   すなわち <literal>tcp</literal>、<literal>http</literal>
   あるいは <literal>ftp</literal> でサポートされるオプションを扱います。
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="options"><!-- {{{ -->
  &reftitle.options;
  <para>
   <variablelist>
    <varlistentry xml:id="context.socket.bindto">
     <term><parameter>bindto</parameter></term>
     <listitem>
      <para>
       PHP がネットワークにアクセスする際の IP アドレス
       (IPv4 あるいは IPv6 のどちらか）やポート番号を指定する際に使用されます。
       書式は、IPv4 アドレスの場合は <literal>ip:port</literal>、
       IPv6 アドレスの場合は <literal>[ip]:port</literal> です。
       IP やポート番号に
       <literal>0</literal> を指定すると、それをシステムに自動的に設定させる
       ことができます。
      </para>
      <note>
       <para>
        FTP の通常の操作では 2 つのソケット接続を使用するので、
        このオプションでポート番号を指定することができません。
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.socket.backlog">
     <term><parameter>backlog</parameter></term>
     <listitem>
      <para>
       ソケットのリスンキューから出て行く接続の数を制限します。
      </para>
      <note>
       <para>
        <function>stream_socket_server</function> でのみ有効です。
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.socket.ipv6_v6only">
     <term><parameter>ipv6_v6only</parameter></term>
     <listitem>
      <para>
       IPv4射影アドレスに関する OS のデフォルトを上書きする
      </para>
      <note>
       <para>
        これは、<literal>[::]</literal> に バインドされたアドレスが存在するときに、
        IPv4 アドレス で listen しようとする場合に特に重要です。
        上で、
       </para>
       <para>
        <function>stream_socket_server</function> でのみ有効です。
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.socket.so_reuseport">
     <term><parameter>so_reuseport</parameter></term>
     <listitem>
      <para>
       異なるプロセスからであっても、同じ IPアドレス:ポート のペアに 複数 bind することを許可します。
      </para>
      <note>
       <para>
        <function>stream_socket_server</function> でのみ有効です。
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.socket.so_broadcast">
     <term><parameter>so_broadcast</parameter></term>
     <listitem>
      <para>
       ブロードキャストアドレスへのデータの送信や、
       ブロードキャストアドレスからのデータの受信を有効にします。
      </para>
      <note>
       <para>
        <function>stream_socket_server</function> でのみ有効です。
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.socket.tcp_nodelay">
     <term><parameter>tcp_nodelay</parameter></term>
     <listitem>
      <para>
       このオプションを &true; にすると、
       <literal>SOL_TCP,NO_DELAY=1</literal> をそれぞれ設定します。
       これによって、TCP の Nagle アルゴリズムを無効にします。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="changelog"><!-- {{{ -->
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.1.0</entry>
       <entry>
        <parameter>tcp_nodelay</parameter> が追加されました。
       </entry>
      </row>
      <row>
       <entry>7.0.1</entry>
       <entry>
        <parameter>ipv6_v6only</parameter> が追加されました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example xml:id="context.socket.example-bindto"><!-- {{{ -->
    <title>基本的な <parameter>bindto</parameter> の使用例</title>
    <programlisting role="php">
<![CDATA[
<?php
// IP アドレス '192.168.0.100' でインターネットに接続する
$opts = array(
    'socket' => array(
        'bindto' => '192.168.0.100:0',
    ),
);


// IP アドレス '192.168.0.100' とポート番号 '7000' でインターネットに接続する
$opts = array(
    'socket' => array(
        'bindto' => '192.168.0.100:7000',
    ),
);


// IPv6 アドレス '2001:db8::1' とポート番号 '7000' でインターネットに接続する
$opts = array(
    'socket' => array(
        'bindto' => '[2001:db8::1]:7000',
    ),
);


// ポート番号 '7000' でインターネットに接続する
$opts = array(
    'socket' => array(
        'bindto' => '0:7000',
    ),
);


// コンテキストを作成し…
$context = stream_context_create($opts);

// …そしてデータを取得するためにそれを使用する
echo file_get_contents('http://www.example.com', false, $context);

?>
]]>
    </programlisting>
   </example><!-- }}} -->
  </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
-->