<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Shutdown a full-duplex connection</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-socket-server.html">stream_socket_server</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-supports-lock.html">stream_supports_lock</a></div>
<div class="up"><a href="ref.stream.html">Stream Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.stream-socket-shutdown" class="refentry">
<div class="refnamediv">
<h1 class="refname">stream_socket_shutdown</h1>
<p class="verinfo">(PHP 5 >= 5.2.1)</p><p class="refpurpose"><span class="refname">stream_socket_shutdown</span> — <span class="dc-title">Shutdown a full-duplex connection</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.stream-socket-shutdown-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>stream_socket_shutdown</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$stream</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$how</code></span>
)</div>
<p class="para rdfs-comment">
Shutdowns (partially or not) a full-duplex connection.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.stream-socket-shutdown-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">stream</code></em></span>
<dd>
<p class="para">
An open stream (opened with <span class="function"><a href="function.stream-socket-client.html" class="function">stream_socket_client()</a></span>,
for example)
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">how</code></em></span>
<dd>
<p class="para">
One of the following constants: <strong><code>STREAM_SHUT_RD</code></strong>
(disable further receptions), <strong><code>STREAM_SHUT_WR</code></strong>
(disable further transmissions) or
<strong><code>STREAM_SHUT_RDWR</code></strong> (disable further receptions and
transmissions).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.stream-socket-shutdown-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.stream-socket-shutdown-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4041">
<p><strong>Example #1 A <span class="function"><strong>stream_socket_shutdown()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$server </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_socket_server</span><span style="color: #007700">(</span><span style="color: #DD0000">'tcp://127.0.0.1:1337'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$client </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_socket_client</span><span style="color: #007700">(</span><span style="color: #DD0000">'tcp://127.0.0.1:1337'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">fputs</span><span style="color: #007700">(</span><span style="color: #0000BB">$client</span><span style="color: #007700">, </span><span style="color: #DD0000">"hello"</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">stream_socket_shutdown</span><span style="color: #007700">(</span><span style="color: #0000BB">$client</span><span style="color: #007700">, </span><span style="color: #0000BB">STREAM_SHUT_WR</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">fputs</span><span style="color: #007700">(</span><span style="color: #0000BB">$client</span><span style="color: #007700">, </span><span style="color: #DD0000">"hello"</span><span style="color: #007700">)); </span><span style="color: #FF8000">// doesn't work now<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
int(5)
Notice: fputs(): send of 5 bytes failed with errno=32 Broken pipe in test.php on line 9
int(0)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.stream-socket-shutdown-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.fclose.html" class="function" rel="rdfs-seeAlso">fclose()</a> - Closes an open file pointer</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-socket-server.html">stream_socket_server</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-supports-lock.html">stream_supports_lock</a></div>
<div class="up"><a href="ref.stream.html">Stream Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
