<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sockets.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.socket-write.php',
    1 => 'socket_write',
    2 => 'ソケットに書き込む',
  ),
  'up' => 
  array (
    0 => 'ref.sockets.php',
    1 => 'ソケット 関数',
  ),
  'prev' => 
  array (
    0 => 'function.socket-strerror.php',
    1 => 'socket_strerror',
  ),
  'next' => 
  array (
    0 => 'function.socket-wsaprotocol-info-export.php',
    1 => 'socket_wsaprotocol_info_export',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/sockets/functions/socket-write.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.socket-write" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">socket_write</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">socket_write</span> &mdash; <span class="dc-title">ソケットに書き込む</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.socket-write-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>socket_write</strong></span>(<span class="methodparam"><span class="type"><a href="class.socket.php" class="type Socket">Socket</a></span> <code class="parameter">$socket</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$length</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   関数 <span class="function"><strong>socket_write()</strong></span> は、
   <code class="parameter">data</code> の内容をソケット
   <code class="parameter">socket</code> に書き込みます。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.socket-write-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">socket</code></dt>
     <dd>
      <p class="para">
      </p>
     </dd>
    
    
     <dt><code class="parameter">data</code></dt>
     <dd>
      <p class="para">
       書き込まれるバッファ。
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       オプションのパラメータ <code class="parameter">length</code> で、
       ソケットに書き込むバイト数を指定することが可能です。
       この値が <code class="parameter">data</code> より大きい場合、自動的に <code class="parameter">data</code> のサイズに切り詰められます。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.socket-write-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   ソケットへの書き込みに成功したデータのバイト数を返します。失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
   エラーコードは <span class="function"><a href="function.socket-last-error.php" class="function">socket_last_error()</a></span>
   を用いて取得することができ、この値を <span class="function"><a href="function.socket-strerror.php" class="function">socket_strerror()</a></span>
   に渡すことでエラー情報を文字列で取得可能です。
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    <span class="function"><strong>socket_write()</strong></span> がゼロを返すことも十分ありえます。
    これは、書き込むデータが存在しなかったことを意味します。
    エラーをチェックするために <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> かどうかを調べる際には、必ず
    <code class="literal">===</code> 演算子を使用しましょう。
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.socket-write-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
  <td>8.0.0</td>
  <td>
   <code class="parameter">socket</code> は、<span class="classname"><a href="class.socket.php" class="classname">Socket</a></span> クラスのインスタンスになりました。
   これより前のバージョンでは、リソース型でした。
  </td>
 </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">length</code> は、nullable になりました。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 notes" id="refsect1-function.socket-write-notes">
  <h3 class="title">注意</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    <span class="function"><strong>socket_write()</strong></span> は、<code class="parameter">data</code> の内容を必ずしもすべて
    書き込むとは限りません。ネットワークバッファの状態にもよりますが、
    ある量のデータだけ、たとえば 1 バイトだけ書き込まれたのであったとしても、
    そして <code class="parameter">data</code> のサイズがそれより大きかったとしても、
    それはエラーではなく正常な動作です。
    そのため、<code class="parameter">data</code> の残りが転送されたことを保証するには、
    ループを使う必要があります。
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.socket-write-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.socket-accept.php" class="function" rel="rdfs-seeAlso">socket_accept()</a> - ソケットへの接続を許可する</span></li>
    <li><span class="function"><a href="function.socket-bind.php" class="function" rel="rdfs-seeAlso">socket_bind()</a> - ソケットに名前をバインドする</span></li>
    <li><span class="function"><a href="function.socket-connect.php" class="function" rel="rdfs-seeAlso">socket_connect()</a> - ソケット上の接続を初期化する</span></li>
    <li><span class="function"><a href="function.socket-listen.php" class="function" rel="rdfs-seeAlso">socket_listen()</a> - ソケット上で接続待ち(listen)する</span></li>
    <li><span class="function"><a href="function.socket-read.php" class="function" rel="rdfs-seeAlso">socket_read()</a> - ソケットから最大バイト長まで読みこむ</span></li>
    <li><span class="function"><a href="function.socket-strerror.php" class="function" rel="rdfs-seeAlso">socket_strerror()</a> - ソケットエラーの内容を文字列として返す</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>