<!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>Sets socket options for the socket</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.socket-set-nonblock.html">socket_set_nonblock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.socket-shutdown.html">socket_shutdown</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-set-option" class="refentry">
<div class="refnamediv">
<h1 class="refname">socket_set_option</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">socket_set_option</span> — <span class="dc-title">Sets socket options for the socket</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.socket-set-option-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>socket_set_option</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">$level</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$optname</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$optval</code></span>
)</div>
<p class="para rdfs-comment">
The <span class="function"><strong>socket_set_option()</strong></span> function sets the option
specified by the <em><code class="parameter">optname</code></em> parameter, at the
specified protocol <em><code class="parameter">level</code></em>, to the value pointed to
by the <em><code class="parameter">optval</code></em> parameter for the
<em><code class="parameter">socket</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.socket-set-option-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>
or <span class="function"><a href="function.socket-accept.html" class="function">socket_accept()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">level</code></em></span>
<dd>
<p class="para">
The <em><code class="parameter">level</code></em> parameter specifies the protocol
level at which the option resides. For example, to retrieve options at
the socket level, a <em><code class="parameter">level</code></em> parameter of
<strong><code>SOL_SOCKET</code></strong> would be used. Other levels, such as
TCP, can be used by specifying the protocol number of that level.
Protocol numbers can be found by using the
<span class="function"><a href="function.getprotobyname.html" class="function">getprotobyname()</a></span> function.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">optname</code></em></span>
<dd>
<p class="para">
The available socket options are the same as those for the
<span class="function"><a href="function.socket-get-option.html" class="function">socket_get_option()</a></span> function.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">optval</code></em></span>
<dd>
<p class="para">
The option value.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.socket-set-option-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.socket-set-option-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4603">
<p><strong>Example #1 <span class="function"><strong>socket_set_option()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$socket </span><span style="color: #007700">= </span><span style="color: #0000BB">socket_create</span><span style="color: #007700">(</span><span style="color: #0000BB">AF_INET</span><span style="color: #007700">, </span><span style="color: #0000BB">SOCK_STREAM</span><span style="color: #007700">, </span><span style="color: #0000BB">SOL_TCP</span><span style="color: #007700">);<br /><br />if (!</span><span style="color: #0000BB">is_resource</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">'Unable to create socket: '</span><span style="color: #007700">. </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">PHP_EOL</span><span style="color: #007700">;<br />}<br /><br />if (!</span><span style="color: #0000BB">socket_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #0000BB">SOL_SOCKET</span><span style="color: #007700">, </span><span style="color: #0000BB">SO_REUSEADDR</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">'Unable to set option on socket: '</span><span style="color: #007700">. </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">PHP_EOL</span><span style="color: #007700">;<br />}<br /><br />if (!</span><span style="color: #0000BB">socket_bind</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #DD0000">'127.0.0.1'</span><span style="color: #007700">, </span><span style="color: #0000BB">1223</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">'Unable to bind socket: '</span><span style="color: #007700">. </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">PHP_EOL</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">$rval </span><span style="color: #007700">= </span><span style="color: #0000BB">socket_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #0000BB">SOL_SOCKET</span><span style="color: #007700">, </span><span style="color: #0000BB">SO_REUSEADDR</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$rval </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Unable to get socket option: '</span><span style="color: #007700">. </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">PHP_EOL</span><span style="color: #007700">;<br />} else if (</span><span style="color: #0000BB">$rval </span><span style="color: #007700">!== </span><span style="color: #0000BB">0</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'SO_REUSEADDR is set on socket !' </span><span style="color: #007700">. </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.socket-set-option-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>4.3.0</td>
<td>
This function was renamed. It used to be called
<span class="function"><strong>socket_setopt()</strong></span>.
</td>
</tr>
</tbody>
</table>
</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-nonblock.html">socket_set_nonblock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.socket-shutdown.html">socket_shutdown</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>
