<!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>Shuts down a socket for receiving, sending, or both</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.socket-set-option.html">socket_set_option</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.socket-strerror.html">socket_strerror</a></div> <div class="up"><a href="ref.sockets.html">Socket Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.socket-shutdown" class="refentry"> <div class="refnamediv"> <h1 class="refname">socket_shutdown</h1> <p class="verinfo">(PHP 4 >= 4.1.0, PHP 5)</p><p class="refpurpose"><span class="refname">socket_shutdown</span> — <span class="dc-title">Shuts down a socket for receiving, sending, or both</span></p> </div> <div class="refsect1 description" id="refsect1-function.socket-shutdown-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>socket_shutdown</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$socket</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$how</code><span class="initializer"> = 2</span></span> ] )</div> <p class="para rdfs-comment"> The <span class="function"><strong>socket_shutdown()</strong></span> function allows you to stop incoming, outgoing or all data (the default) from being sent through the <em><code class="parameter">socket</code></em> </p> </div> <div class="refsect1 parameters" id="refsect1-function.socket-shutdown-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">socket</code></em></span> <dd> <p class="para"> A valid socket resource created with <span class="function"><a href="function.socket-create.html" class="function">socket_create()</a></span>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">how</code></em></span> <dd> <p class="para"> The value of <em><code class="parameter">how</code></em> can be one of the following: <table class="doctable table"> <caption><strong>possible values for <em><code class="parameter">how</code></em></strong></caption> <tbody class="tbody"> <tr> <td><em>0</em></td> <td> Shutdown socket reading </td> </tr> <tr> <td><em>1</em></td> <td> Shutdown socket writing </td> </tr> <tr> <td><em>2</em></td> <td> Shutdown socket reading and writing </td> </tr> </tbody> </table> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.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><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.socket-set-option.html">socket_set_option</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.socket-strerror.html">socket_strerror</a></div> <div class="up"><a href="ref.sockets.html">Socket Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>