<!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>Create an Internet or Unix domain server socket</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-socket-sendto.html">stream_socket_sendto</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-socket-shutdown.html">stream_socket_shutdown</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-server" class="refentry">
<div class="refnamediv">
<h1 class="refname">stream_socket_server</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">stream_socket_server</span> — <span class="dc-title">Create an Internet or Unix domain server socket</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.stream-socket-server-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>stream_socket_server</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$local_socket</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$errno</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$errstr</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = STREAM_SERVER_BIND | STREAM_SERVER_LISTEN</span></span>
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$context</code></span>
]]]] )</div>
<p class="para rdfs-comment">
Creates a stream or datagram socket on the specified
<em><code class="parameter">local_socket</code></em>.
</p>
<p class="para">
This function only creates a socket, to begin accepting connections
use <span class="function"><a href="function.stream-socket-accept.html" class="function">stream_socket_accept()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.stream-socket-server-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">local_socket</code></em></span>
<dd>
<p class="para">
The type of socket created is determined by the transport specified
using standard URL formatting: <em>transport://target</em>.
</p>
<p class="para">
For Internet Domain sockets (<strong><code>AF_INET</code></strong>) such as TCP and UDP, the
<em>target</em> portion of the
<em><code class="parameter">remote_socket</code></em> parameter should consist of a
hostname or IP address followed by a colon and a port number. For
Unix domain sockets, the <em>target</em> portion should
point to the socket file on the filesystem.
</p>
<p class="para">
Depending on the environment, Unix domain sockets may not be available.
A list of available transports can be retrieved using
<span class="function"><a href="function.stream-get-transports.html" class="function">stream_get_transports()</a></span>. See
<a href="transports.html" class="xref">List of Supported Socket Transports</a> for a list of bulitin transports.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">errno</code></em></span>
<dd>
<p class="para">
If the optional <em><code class="parameter">errno</code></em> and <em><code class="parameter">errstr</code></em>
arguments are present they will be set to indicate the actual system
level error that occurred in the system-level <em>socket()</em>,
<em>bind()</em>, and <em>listen()</em> calls. If
the value returned in <em><code class="parameter">errno</code></em> is
<em>0</em> and the function returned <strong><code>FALSE</code></strong>, it is an
indication that the error occurred before the <em>bind()</em>
call. This is most likely due to a problem initializing the socket.
Note that the <em><code class="parameter">errno</code></em> and
<em><code class="parameter">errstr</code></em> arguments will always be passed by reference.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">errstr</code></em></span>
<dd>
<p class="para">
See <em><code class="parameter">errno</code></em> description.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
A bitmask field which may be set to any combination of socket creation
flags.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
For UDP sockets, you must use <strong><code>STREAM_SERVER_BIND</code></strong> as
the <em><code class="parameter">flags</code></em> parameter.
</p>
</p></blockquote>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">context</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.stream-socket-server-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the created stream, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.stream-socket-server-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4039">
<p><strong>Example #1 Using TCP server sockets</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">stream_socket_server</span><span style="color: #007700">(</span><span style="color: #DD0000">"tcp://0.0.0.0:8000"</span><span style="color: #007700">, </span><span style="color: #0000BB">$errno</span><span style="color: #007700">, </span><span style="color: #0000BB">$errstr</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$socket</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$errstr</span><span style="color: #DD0000"> (</span><span style="color: #0000BB">$errno</span><span style="color: #DD0000">)<br />\n"</span><span style="color: #007700">;<br />} else {<br /> while (</span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_socket_accept</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">'The local time is ' </span><span style="color: #007700">. </span><span style="color: #0000BB">date</span><span style="color: #007700">(</span><span style="color: #DD0000">'n/j/Y g:i a'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /> }<br /> </span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
The example below shows how to act as a time server which can respond
to time queries as shown in an example on <span class="function"><a href="function.stream-socket-client.html" class="function">stream_socket_client()</a></span>.
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
Most systems require root access to create a server socket on a port
below 1024.
</span>
</p></blockquote>
<div class="example" id="example-4040">
<p><strong>Example #2 Using UDP server sockets</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">stream_socket_server</span><span style="color: #007700">(</span><span style="color: #DD0000">"udp://127.0.0.1:1113"</span><span style="color: #007700">, </span><span style="color: #0000BB">$errno</span><span style="color: #007700">, </span><span style="color: #0000BB">$errstr</span><span style="color: #007700">, </span><span style="color: #0000BB">STREAM_SERVER_BIND</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$socket</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">"</span><span style="color: #0000BB">$errstr</span><span style="color: #DD0000"> (</span><span style="color: #0000BB">$errno</span><span style="color: #DD0000">)"</span><span style="color: #007700">);<br />}<br /><br />do {<br /> </span><span style="color: #0000BB">$pkt </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_socket_recvfrom</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">$peer</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$peer</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">stream_socket_sendto</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #0000BB">date</span><span style="color: #007700">(</span><span style="color: #DD0000">"D M j H:i:s Y\r\n"</span><span style="color: #007700">), </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">$peer</span><span style="color: #007700">);<br />} while (</span><span style="color: #0000BB">$pkt </span><span style="color: #007700">!== </span><span style="color: #0000BB">false</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.stream-socket-server-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">When specifying a numerical IPv6 address
(e.g. <em>fe80::1</em>), you must enclose the IP in square
brackets—for example, <em>tcp://[fe80::1]:80</em>.</span></p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.stream-socket-server-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.stream-socket-client.html" class="function" rel="rdfs-seeAlso">stream_socket_client()</a> - Open Internet or Unix domain socket connection</span></li>
<li class="member"> <span class="function"><a href="function.stream-set-blocking.html" class="function" rel="rdfs-seeAlso">stream_set_blocking()</a> - Set blocking/non-blocking mode on a stream</span></li>
<li class="member"> <span class="function"><a href="function.stream-set-timeout.html" class="function" rel="rdfs-seeAlso">stream_set_timeout()</a> - Set timeout period on a stream</span></li>
<li class="member"> <span class="function"><a href="function.fgets.html" class="function" rel="rdfs-seeAlso">fgets()</a> - Gets line from file pointer</span></li>
<li class="member"> <span class="function"><a href="function.fgetss.html" class="function" rel="rdfs-seeAlso">fgetss()</a> - Gets line from file pointer and strip HTML tags</span></li>
<li class="member"> <span class="function"><a href="function.fwrite.html" class="function" rel="rdfs-seeAlso">fwrite()</a> - Binary-safe file write</span></li>
<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>
<li class="member"> <span class="function"><a href="function.feof.html" class="function" rel="rdfs-seeAlso">feof()</a> - Tests for end-of-file on a file pointer</span></li>
<li class="member"><a href="ref.curl.html" class="link">Curl extension</a></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-socket-sendto.html">stream_socket_sendto</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-socket-shutdown.html">stream_socket_shutdown</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>
