socket-sendto.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e50e79746736dbdfbabe9bd3566793b3ddf38f58 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.socket-sendto" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_sendto</refname>
  <refpurpose>接続しているかどうかによらずソケットにメッセージを送信する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>socket_sendto</methodname>
   <methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>int</type><parameter>length</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   <methodparam><type>string</type><parameter>address</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>port</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   関数 <function>socket_sendto</function> は、
   アドレス <parameter>addr</parameter> の <parameter>port</parameter>
   を使用し、
   <parameter>data</parameter> からソケット <parameter>socket</parameter>
   に <parameter>length</parameter> バイトのデータを送信します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       <function>socket_create</function> で作成した <classname>Socket</classname> クラスのインスタンス。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       送信するデータが、<parameter>data</parameter> から取り出されます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       <parameter>data</parameter> から
       <parameter>length</parameter> バイト分のデータが送信されます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <parameter>flags</parameter> の値は、以下のフラグの任意の組み合わせを
       論理 OR 演算子 (<literal>|</literal>) で連結したものとなります。
       <table>
        <title><parameter>flags</parameter> がとりうる値</title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><constant>MSG_OOB</constant></entry>
           <entry>
            OOB（out-of-band: 帯域外）データを送信します。
           </entry>
          </row>
          <row>
           <entry><constant>MSG_EOR</constant></entry>
           <entry>
            レコードにマークをつけます。
            レコードでデータがそろいます。
           </entry>
          </row>
          <row>
           <entry><constant>MSG_EOF</constant></entry>
           <entry>
            ソケットの送信側を閉じ、そのことを知らせる通知を送信データの最後に付加します。
            トランザクションでデータがそろいます。
           </entry>
          </row>
          <row>
           <entry><constant>MSG_DONTROUTE</constant></entry>
           <entry>
            ルータを使用せず、直接つながっているインターフェイスのみを使用します。
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>address</parameter></term>
     <listitem>
      <para>
       リモートホストの IP アドレス。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       <parameter>port</parameter> は、
       データの送信先となるリモートホストのポート番号です。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>socket_sendto</function> は、リモートホストに送信したバイト数を返します。
   エラーが発生した場合は &false; を返します。
  </para>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>socket_sendto</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
    $sock = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);

    $msg = "Ping !";
    $len = strlen($msg);

    socket_sendto($sock, $msg, $len, 0, '127.0.0.1', 1223);
    socket_close($sock);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>socket_send</function></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
-->