PageRenderTime 48ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/php/function.socket-recv.html

https://bitbucket.org/thncr/manuals
HTML | 227 lines | 181 code | 46 blank | 0 comment | 0 complexity | e8f45ed0e888495871835cc7c52c67d3 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3.  <head>
    4. 

  4.   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    5. 

  5.   <title>Receives data from a connected socket</title>
    6. 

  6. 

  7.  </head>
    8. 

  8.  <body><div class="manualnavbar" style="text-align: center;">
    9. 

  9.  <div class="prev" style="text-align: left; float: left;"><a href="function.socket-read.html">socket_read</a></div>
    10. 

  10.  <div class="next" style="text-align: right; float: right;"><a href="function.socket-recvfrom.html">socket_recvfrom</a></div>
    11. 

  11.  <div class="up"><a href="ref.sockets.html">Socket 函数</a></div>
    12. 

  12.  <div class="home"><a href="index.html">PHP Manual</a></div>
    13. 

  13. </div><hr /><div id="function.socket-recv" class="refentry">
    14. 

  14.  <div class="refnamediv">
    15. 

  15.   <h1 class="refname">socket_recv</h1>
    16. 

  16.   <p class="verinfo">(PHP 4 &gt;= 4.1.0, PHP 5)</p><p class="refpurpose"><span class="refname">socket_recv</span> &mdash; <span class="dc-title">Receives data from a connected socket </span></p>
    17. 

  17. 

  18.  </div>
    19. 

  19.  
    20. 

  20.  <div class="refsect1 description" id="refsect1-function.socket-recv-description">
    21. 

  21.   <h3 class="title">说明</h3>
    22. 

  22.   <div class="methodsynopsis dc-description">
    23. 

  23.    <span class="type">int</span> <span class="methodname"><strong>socket_recv</strong></span>
    24. 

  24.     ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$socket</code></span>
    25. 

  25.    , <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$buf</code></span>
    26. 

  26.    , <span class="methodparam"><span class="type">int</span> <code class="parameter">$len</code></span>
    27. 

  27.    , <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
    28. 

  28.    )</div>
    29. 

  29. 

  30.   <p class="para rdfs-comment">
    31. 

  31.    The  <span class="function"><strong>socket_recv()</strong></span> function receives
    32. 

  32.    <em><code class="parameter">len</code></em> bytes of data in <em><code class="parameter">buf</code></em> from
    33. 

  33.    <em><code class="parameter">socket</code></em>.  <span class="function"><strong>socket_recv()</strong></span> can
    34. 

  34.    be used to gather data from connected sockets. Additionally, one or
    35. 

  35.    more flags can be specified to modify the behaviour of the
    36. 

  36.    function.
    37. 

  37.   </p>
    38. 

  38.   <p class="para">
    39. 

  39.    <em><code class="parameter">buf</code></em> is passed by reference, so it must be
    40. 

  40.    specified as a variable in the argument list. Data read from
    41. 

  41.    <em><code class="parameter">socket</code></em> by  <span class="function"><strong>socket_recv()</strong></span>
    42. 

  42.    will be returned in <em><code class="parameter">buf</code></em>.
    43. 

  43.   </p>
    44. 

  44.  </div>
    45. 

  45. 

  46. 

  47.  <div class="refsect1 parameters" id="refsect1-function.socket-recv-parameters">
    48. 

  48.   <h3 class="title">参数</h3>
    49. 

  49.   <p class="para">
    50. 

  50.    <dl>
    51. 

  51. 

  52.     <dt>
    53. 

  53. 

  54.      <span class="term"><em><code class="parameter">socket</code></em></span>
    55. 

  55.      <dd>
    56. 

  56. 

  57.       <p class="para">
    58. 

  58.        The <em><code class="parameter">socket</code></em> must be a socket resource previously
    59. 

  59.        created by socket_create().
    60. 

  60.       </p>
    61. 

  61.      </dd>
    62. 

  62. 

  63.     </dt>
    64. 

  64. 

  65. 

  66.     <dt>
    67. 

  67. 

  68.      <span class="term"><em><code class="parameter">buf</code></em></span>
    69. 

  69.      <dd>
    70. 

  70. 

  71.       <p class="para">
    72. 

  72.        The data received will be fetched to the variable specified with
    73. 

  73.        <em><code class="parameter">buf</code></em>. If an error occurs, if the
    74. 

  74.        connection is reset, or if no data is
    75. 

  75.        available, <em><code class="parameter">buf</code></em> will be set to <strong><code>NULL</code></strong>.
    76. 

  76.       </p>
    77. 

  77.      </dd>
    78. 

  78. 

  79.     </dt>
    80. 

  80. 

  81. 

  82.     <dt>
    83. 

  83. 

  84.      <span class="term"><em><code class="parameter">len</code></em></span>
    85. 

  85.      <dd>
    86. 

  86. 

  87.       <p class="para">
    88. 

  88.        Up to <em><code class="parameter">len</code></em> bytes will be fetched from remote host.
    89. 

  89.       </p>
    90. 

  90.      </dd>
    91. 

  91. 

  92.     </dt>
    93. 

  93. 

  94. 

  95.     <dt>
    96. 

  96. 

  97.      <span class="term"><em><code class="parameter">flags</code></em></span>
    98. 

  98.      <dd>
    99. 

  99. 

  100.       <p class="para">
    101. 

  101.        The value of <em><code class="parameter">flags</code></em> can be any combination of 
    102. 

  102.        the following flags, joined with the binary OR (<em>|</em>)
    103. 

  103.        operator.
    104. 

  104.       </p>
    105. 

  105.       
    106. 

  106.       <table class="doctable table">
    107. 

  107.        <caption><strong>Possible values for <em><code class="parameter">flags</code></em></strong></caption>
    108. 

  108.        
    109. 

  109.         <thead>
    110. 

  110.          <tr>
    111. 

  111.           <th>Flag</th>
    112. 

  112.           <th>Description</th>
    113. 

  113.          </tr>
    114. 

  114. 

  115.         </thead>
    116. 

  116. 

  117.         <tbody class="tbody">
    118. 

  118.          <tr>
    119. 

  119.           <td><strong><code>MSG_OOB</code></strong></td>
    120. 

  120.           <td>
    121. 

  121.            Process out-of-band data.
    122. 

  122.           </td>
    123. 

  123.          </tr>
    124. 

  124. 

  125.          <tr>
    126. 

  126.           <td><strong><code>MSG_PEEK</code></strong></td>
    127. 

  127.           <td>
    128. 

  128.            Receive data from the beginning of the receive queue without
    129. 

  129.            removing it from the queue.
    130. 

  130.           </td>
    131. 

  131.          </tr>
    132. 

  132. 

  133.          <tr>
    134. 

  134.           <td><strong><code>MSG_WAITALL</code></strong></td>
    135. 

  135.           <td>
    136. 

  136.            Block until at least <em><code class="parameter">len</code></em> are received.
    137. 

  137.            However, if a signal is caught or the remote host disconnects, the
    138. 

  138.            function may return less data.
    139. 

  139.           </td>
    140. 

  140.          </tr>
    141. 

  141. 

  142.          <tr>
    143. 

  143.           <td><strong><code>MSG_DONTWAIT</code></strong></td>
    144. 

  144.           <td>
    145. 

  145.            With this flag set, the function returns even if it would normally
    146. 

  146.            have blocked.
    147. 

  147.           </td>
    148. 

  148.          </tr>
    149. 

  149. 

  150.         </tbody>
    151. 

  151.        
    152. 

  152.       </table>
    153. 

  153. 

  154.      </dd>
    155. 

  155. 

  156.     </dt>
    157. 

  157.     
    158. 

  158.    </dl>
    159. 

  159. 

  160.   </p>
    161. 

  161.  </div>
    162. 

  162. 

  163. 

  164.  <div class="refsect1 returnvalues" id="refsect1-function.socket-recv-returnvalues">
    165. 

  165.   <h3 class="title">返回值</h3>
    166. 

  166.   <p class="para">
    167. 

  167.     <span class="function"><strong>socket_recv()</strong></span> returns the number of bytes received,
    168. 

  168.    or <strong><code>FALSE</code></strong> if there was an error. The actual error code can be retrieved by 
    169. 

  169.    calling  <span class="function"><a href="function.socket-last-error.html" class="function">socket_last_error()</a></span>. This error code may be
    170. 

  170.    passed to  <span class="function"><a href="function.socket-strerror.html" class="function">socket_strerror()</a></span> to get a textual explanation
    171. 

  171.    of the error.
    172. 

  172.   </p>
    173. 

  173.  </div>
    174. 

  174. 

  175. 

  176.  <div class="refsect1 examples" id="refsect1-function.socket-recv-examples">
    177. 

  177.   <h3 class="title">范例</h3>
    178. 

  178.   <p class="para">
    179. 

  179.    <div class="example" id="example-4360">
    180. 

  180.     <p><strong>Example #1  <span class="function"><strong>socket_recv()</strong></span> example</strong></p>
    181. 

  181.     <div class="example-contents"><p>
    182. 

  182.      This example is a simple rewrite of the first example from
    183. 

  183.      <a href="sockets.examples.html" class="xref">范例</a> to
    184. 

  184.      use  <span class="function"><strong>socket_recv()</strong></span>.
    185. 

  185.     </p></div>
    186. 

  186.     <div class="example-contents">
    187. 

  187. <div class="phpcode"><code><span style="color: #000000">
    188. 

  188. <span style="color: #0000BB">&lt;?php<br />error_reporting</span><span style="color: #007700">(</span><span style="color: #0000BB">E_ALL</span><span style="color: #007700">);<br /><br />echo&nbsp;</span><span style="color: #DD0000">"&lt;h2&gt;TCP/IP&nbsp;Connection&lt;/h2&gt;\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/*&nbsp;Get&nbsp;the&nbsp;port&nbsp;for&nbsp;the&nbsp;WWW&nbsp;service.&nbsp;*/<br /></span><span style="color: #0000BB">$service_port&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">getservbyname</span><span style="color: #007700">(</span><span style="color: #DD0000">'www'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'tcp'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/*&nbsp;Get&nbsp;the&nbsp;IP&nbsp;address&nbsp;for&nbsp;the&nbsp;target&nbsp;host.&nbsp;*/<br /></span><span style="color: #0000BB">$address&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">gethostbyname</span><span style="color: #007700">(</span><span style="color: #DD0000">'www.example.com'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/*&nbsp;Create&nbsp;a&nbsp;TCP/IP&nbsp;socket.&nbsp;*/<br /></span><span style="color: #0000BB">$socket&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">socket_create</span><span style="color: #007700">(</span><span style="color: #0000BB">AF_INET</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">SOCK_STREAM</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">SOL_TCP</span><span style="color: #007700">);<br />if&nbsp;(</span><span style="color: #0000BB">$socket&nbsp;</span><span style="color: #007700">===&nbsp;</span><span style="color: #0000BB">false</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"socket_create()&nbsp;failed:&nbsp;reason:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">socket_strerror</span><span style="color: #007700">(</span><span style="color: #0000BB">socket_last_error</span><span style="color: #007700">())&nbsp;.&nbsp;</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}&nbsp;else&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"OK.\n"</span><span style="color: #007700">;<br />}<br /><br />echo&nbsp;</span><span style="color: #DD0000">"Attempting&nbsp;to&nbsp;connect&nbsp;to&nbsp;'</span><span style="color: #0000BB">$address</span><span style="color: #DD0000">'&nbsp;on&nbsp;port&nbsp;'</span><span style="color: #0000BB">$service_port</span><span style="color: #DD0000">'..."</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$result&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">socket_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$address</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$service_port</span><span style="color: #007700">);<br />if&nbsp;(</span><span style="color: #0000BB">$result&nbsp;</span><span style="color: #007700">===&nbsp;</span><span style="color: #0000BB">false</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"socket_connect()&nbsp;failed.\nReason:&nbsp;(</span><span style="color: #0000BB">$result</span><span style="color: #DD0000">)&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">socket_strerror</span><span style="color: #007700">(</span><span style="color: #0000BB">socket_last_error</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">))&nbsp;.&nbsp;</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}&nbsp;else&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"OK.\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">$in&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">"HEAD&nbsp;/&nbsp;HTTP/1.1\r\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$in&nbsp;</span><span style="color: #007700">.=&nbsp;</span><span style="color: #DD0000">"Host:&nbsp;www.example.com\r\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$in&nbsp;</span><span style="color: #007700">.=&nbsp;</span><span style="color: #DD0000">"Connection:&nbsp;Close\r\n\r\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$out&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /><br />echo&nbsp;</span><span style="color: #DD0000">"Sending&nbsp;HTTP&nbsp;HEAD&nbsp;request..."</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">socket_write</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$in</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$in</span><span style="color: #007700">));<br />echo&nbsp;</span><span style="color: #DD0000">"OK.\n"</span><span style="color: #007700">;<br /><br />echo&nbsp;</span><span style="color: #DD0000">"Reading&nbsp;response:\n\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$buf&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'This&nbsp;is&nbsp;my&nbsp;buffer.'</span><span style="color: #007700">;<br />if&nbsp;(</span><span style="color: #0000BB">false&nbsp;</span><span style="color: #007700">!==&nbsp;(</span><span style="color: #0000BB">$bytes&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">socket_recv</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$buf</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">2048</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">MSG_WAITALL</span><span style="color: #007700">)))&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Read&nbsp;</span><span style="color: #0000BB">$bytes</span><span style="color: #DD0000">&nbsp;bytes&nbsp;from&nbsp;socket_recv().&nbsp;Closing&nbsp;socket..."</span><span style="color: #007700">;<br />}&nbsp;else&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"socket_recv()&nbsp;failed;&nbsp;reason:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">socket_strerror</span><span style="color: #007700">(</span><span style="color: #0000BB">socket_last_error</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">))&nbsp;.&nbsp;</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">socket_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">);<br /><br />echo&nbsp;</span><span style="color: #0000BB">$buf&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo&nbsp;</span><span style="color: #DD0000">"OK.\n\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span>
    189. 

  189. </span>
    190. 

  190. </code></div>
    191. 

  191.     </div>
    192. 

  192. 

  193.     <div class="example-contents"><p>
    194. 

  194.      The above example will produce something like:
    195. 

  195.     </p></div>
    196. 

  196.     <div class="example-contents screen">
    197. 

  197. <div class="cdata"><pre>
    198. 

  198. &lt;h2&gt;TCP/IP Connection&lt;/h2&gt;
    199. 

  199. OK.
    200. 

  200. Attempting to connect to &#039;208.77.188.166&#039; on port &#039;80&#039;...OK.
    201. 

  201. Sending HTTP HEAD request...OK.
    202. 

  202. Reading response:
    203. 

  203. 

  204. Read 123 bytes from socket_recv(). Closing socket...HTTP/1.1 200 OK
    205. 

  205. Date: Mon, 14 Sep 2009 08:56:36 GMT
    206. 

  206. Server: Apache/2.2.3 (Red Hat)
    207. 

  207. Last-Modified: Tue, 15 Nov 2005 13:24:10 GMT
    208. 

  208. ETag: &quot;b80f4-1b6-80bfd280&quot;
    209. 

  209. Accept-Ranges: bytes
    210. 

  210. Content-Length: 438
    211. 

  211. Connection: close
    212. 

  212. Content-Type: text/html; charset=UTF-8
    213. 

  213. 

  214. OK.
    215. 

  215. </pre></div>
    216. 

  216.     </div>
    217. 

  217.    </div>
    218. 

  218.   </p>
    219. 

  219.  </div>
    220. 

  220. 

  221.                      
    222. 

  222. </div><hr /><div class="manualnavbar" style="text-align: center;">
    223. 

  223.  <div class="prev" style="text-align: left; float: left;"><a href="function.socket-read.html">socket_read</a></div>
    224. 

  224.  <div class="next" style="text-align: right; float: right;"><a href="function.socket-recvfrom.html">socket_recvfrom</a></div>
    225. 

  225.  <div class="up"><a href="ref.sockets.html">Socket 函数</a></div>
    226. 

  226.  <div class="home"><a href="index.html">PHP Manual</a></div>
    227. 

  227. </div></body></html>
    228. 

  228.