<!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>Binds a name to a socket</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.socket-accept.html">socket_accept</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.socket-clear-error.html">socket_clear_error</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-bind" class="refentry">
<div class="refnamediv">
<h1 class="refname">socket_bind</h1>
<p class="verinfo">(PHP 4 >= 4.1.0, PHP 5)</p><p class="refpurpose"><span class="refname">socket_bind</span> — <span class="dc-title">Binds a name to a socket</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.socket-bind-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>socket_bind</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$socket</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$address</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Binds the name given in <em><code class="parameter">address</code></em> to the socket
described by <em><code class="parameter">socket</code></em>. This has to be done before
a connection is be established using <span class="function"><a href="function.socket-connect.html" class="function">socket_connect()</a></span>
or <span class="function"><a href="function.socket-listen.html" class="function">socket_listen()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.socket-bind-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">address</code></em></span>
<dd>
<p class="para">
If the socket is of the <strong><code>AF_INET</code></strong> family, the
<em><code class="parameter">address</code></em> is an IP in dotted-quad notation
(e.g. <em>127.0.0.1</em>).
</p>
<p class="para">
If the socket is of the <strong><code>AF_UNIX</code></strong> family, the
<em><code class="parameter">address</code></em> is the path of a
Unix-domain socket (e.g. <var class="filename">/tmp/my.sock</var>).
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">port</code></em> (Optional)</span>
<dd>
<p class="para">
The <em><code class="parameter">port</code></em> parameter is only used when
binding an <strong><code>AF_INET</code></strong> socket, and designates
the port on which to listen for connections.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.socket-bind-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>
<p class="para">
The error code can be retrieved with <span class="function"><a href="function.socket-last-error.html" class="function">socket_last_error()</a></span>.
This code may be passed to <span class="function"><a href="function.socket-strerror.html" class="function">socket_strerror()</a></span> to get a
textual explanation of the error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.socket-bind-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4589">
<p><strong>Example #1 Using <span class="function"><strong>socket_bind()</strong></span> to set the source address</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Create a new socket<br /></span><span style="color: #0000BB">$sock </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 /></span><span style="color: #FF8000">// An example list of IP addresses owned by the computer<br /></span><span style="color: #0000BB">$sourceips</span><span style="color: #007700">[</span><span style="color: #DD0000">'kevin'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'127.0.0.1'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$sourceips</span><span style="color: #007700">[</span><span style="color: #DD0000">'madcoder'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'127.0.0.2'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Bind the source address<br /></span><span style="color: #0000BB">socket_bind</span><span style="color: #007700">(</span><span style="color: #0000BB">$sock</span><span style="color: #007700">, </span><span style="color: #0000BB">$sourceips</span><span style="color: #007700">[</span><span style="color: #DD0000">'madcoder'</span><span style="color: #007700">]);<br /><br /></span><span style="color: #FF8000">// Connect to destination address<br /></span><span style="color: #0000BB">socket_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$sock</span><span style="color: #007700">, </span><span style="color: #DD0000">'127.0.0.1'</span><span style="color: #007700">, </span><span style="color: #0000BB">80</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Write<br /></span><span style="color: #0000BB">$request </span><span style="color: #007700">= </span><span style="color: #DD0000">'GET / HTTP/1.1' </span><span style="color: #007700">. </span><span style="color: #DD0000">"\r\n" </span><span style="color: #007700">.<br /> </span><span style="color: #DD0000">'Host: example.com' </span><span style="color: #007700">. </span><span style="color: #DD0000">"\r\n\r\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">socket_write</span><span style="color: #007700">(</span><span style="color: #0000BB">$sock</span><span style="color: #007700">, </span><span style="color: #0000BB">$request</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Close<br /></span><span style="color: #0000BB">socket_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$sock</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.socket-bind-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function must be used on the socket before
<span class="function"><a href="function.socket-connect.html" class="function">socket_connect()</a></span>.
</p>
</p></blockquote>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Windows 9x/ME compatibility note:
<span class="function"><a href="function.socket-last-error.html" class="function">socket_last_error()</a></span> may return an invalid error code
if trying to bind the socket to a wrong address that does not belong to
your machine.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.socket-bind-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.socket-connect.html" class="function" rel="rdfs-seeAlso">socket_connect()</a> - Initiates a connection on a socket</span></li>
<li class="member"> <span class="function"><a href="function.socket-listen.html" class="function" rel="rdfs-seeAlso">socket_listen()</a> - Listens for a connection on a socket</span></li>
<li class="member"> <span class="function"><a href="function.socket-create.html" class="function" rel="rdfs-seeAlso">socket_create()</a> - Create a socket (endpoint for communication)</span></li>
<li class="member"> <span class="function"><a href="function.socket-last-error.html" class="function" rel="rdfs-seeAlso">socket_last_error()</a> - Returns the last error on the socket</span></li>
<li class="member"> <span class="function"><a href="function.socket-strerror.html" class="function" rel="rdfs-seeAlso">socket_strerror()</a> - Return a string describing a socket error</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.socket-accept.html">socket_accept</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.socket-clear-error.html">socket_clear_error</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>
