<?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 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.socket-read.php',
    1 => 'socket_read',
    2 => '从套接字中读取最大长度的数据',
  ),
  'up' => 
  array (
    0 => 'ref.sockets.php',
    1 => 'Socket 函数',
  ),
  'prev' => 
  array (
    0 => 'function.socket-listen.php',
    1 => 'socket_listen',
  ),
  'next' => 
  array (
    0 => 'function.socket-recv.php',
    1 => 'socket_recv',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/sockets/functions/socket-read.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.socket-read" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">socket_read</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">socket_read</span> &mdash; <span class="dc-title">从套接字中读取最大长度的数据</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.socket-read-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>socket_read</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.integer.php" class="type int">int</a></span> <code class="parameter">$length</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$mode</code><span class="initializer"> = <strong><code><a href="sockets.constants.php#constant.php-binary-read">PHP_BINARY_READ</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</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_read()</strong></span> 函数是从 <span class="function"><a href="function.socket-create.php" class="function">socket_create()</a></span>
   或 <span class="function"><a href="function.socket-accept.php" class="function">socket_accept()</a></span> 函数所创建的 <span class="classname"><a href="class.socket.php" class="classname">Socket</a></span>
   实例 <code class="parameter">socket</code> 中读取数据。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.socket-read-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">socket</code></dt>
     <dd>
      <p class="para">
       使用 <span class="function"><a href="function.socket-create.php" class="function">socket_create()</a></span>
       或 <span class="function"><a href="function.socket-accept.php" class="function">socket_accept()</a></span>
       函数创建的 <span class="classname"><a href="class.socket.php" class="classname">Socket</a></span> 实例。
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">length</code> 参数指定了最大能够读取的字节数。否则您可以使用
       <code class="literal">\r</code>、<code class="literal">\n</code>、<code class="literal">\0</code>
       结束读取（根据 <code class="parameter">mode</code> 参数设置，请参见下文）。
      </p>
     </dd>
    
    
     <dt><code class="parameter">mode</code></dt>
     <dd>
      <p class="para">
       可选参数 <code class="parameter">mode</code> 是一个命名常量：
       <ul class="itemizedlist">
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="sockets.constants.php#constant.php-binary-read">PHP_BINARY_READ</a></code></strong> （默认）- 使用系统的
          <code class="literal">recv()</code> 函数。二进制安全地读取数据。
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="sockets.constants.php#constant.php-normal-read">PHP_NORMAL_READ</a></code></strong> - 读取到
          <code class="literal">\n</code>、<code class="literal">\r</code> 时停止。
         </span>
        </li>
       </ul>
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.socket-read-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   <span class="function"><strong>socket_read()</strong></span> 返回一个字符串，表示接收到的数据。如果发生了错误（包括远程主机关闭了连接），则返回 <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_read()</strong></span>
    返回一个长度为 0 的空字符串（&quot;&quot;）。
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.socket-read-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> 实例，
   之前是 <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>。
  </td>
 </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.socket-read-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> - 监听套接字的连接</span></li>
    <li><span class="function"><a href="function.socket-last-error.php" class="function" rel="rdfs-seeAlso">socket_last_error()</a> - 返回套接字上的最后一个错误</span></li>
    <li><span class="function"><a href="function.socket-strerror.php" class="function" rel="rdfs-seeAlso">socket_strerror()</a> - 返回描述套接字错误的字符串</span></li>
    <li><span class="function"><a href="function.socket-write.php" class="function" rel="rdfs-seeAlso">socket_write()</a> - 向套接字写数据</span></li>
   </ul>
  </p>
 </div>


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