mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
209 lines
6.5 KiB
XML
209 lines
6.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.stream-socket-server" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>stream_socket_server</refname>
|
|
<refpurpose>Create an Internet or Unix domain server socket</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>stream_socket_server</methodname>
|
|
<methodparam><type>string</type><parameter>local_socket</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter role="reference">errno</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter role="reference">errstr</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>STREAM_SERVER_BIND | STREAM_SERVER_LISTEN</initializer></methodparam>
|
|
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Creates a stream or datagram socket on the specified
|
|
<parameter>local_socket</parameter>.
|
|
</para>
|
|
<para>
|
|
This function only creates a socket, to begin accepting connections
|
|
use <function>stream_socket_accept</function>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>local_socket</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The type of socket created is determined by the transport specified
|
|
using standard URL formatting: <literal>transport://target</literal>.
|
|
</para>
|
|
<para>
|
|
For Internet Domain sockets (<constant>AF_INET</constant>) such as TCP and UDP, the
|
|
<literal>target</literal> portion of the
|
|
<parameter>remote_socket</parameter> parameter should consist of a
|
|
hostname or IP address followed by a colon and a port number. For
|
|
Unix domain sockets, the <literal>target</literal> portion should
|
|
point to the socket file on the filesystem.
|
|
</para>
|
|
<para>
|
|
Depending on the environment, Unix domain sockets may not be available.
|
|
A list of available transports can be retrieved using
|
|
<function>stream_get_transports</function>. See
|
|
<xref linkend="transports"/> for a list of bulitin transports.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>errno</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If the optional <parameter>errno</parameter> and <parameter>errstr</parameter>
|
|
arguments are present they will be set to indicate the actual system
|
|
level error that occurred in the system-level <literal>socket()</literal>,
|
|
<literal>bind()</literal>, and <literal>listen()</literal> calls. If
|
|
the value returned in <parameter>errno</parameter> is
|
|
<literal>0</literal> and the function returned &false;, it is an
|
|
indication that the error occurred before the <literal>bind()</literal>
|
|
call. This is most likely due to a problem initializing the socket.
|
|
Note that the <parameter>errno</parameter> and
|
|
<parameter>errstr</parameter> arguments will always be passed by reference.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>errstr</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
See <parameter>errno</parameter> description.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A bitmask field which may be set to any combination of socket creation
|
|
flags.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
For UDP sockets, you must use <constant>STREAM_SERVER_BIND</constant> as
|
|
the <parameter>flags</parameter> parameter.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>context</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the created stream, or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Using TCP server sockets</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$socket = stream_socket_server("tcp://0.0.0.0:8000", $errno, $errstr);
|
|
if (!$socket) {
|
|
echo "$errstr ($errno)<br />\n";
|
|
} else {
|
|
while ($conn = stream_socket_accept($socket)) {
|
|
fwrite($conn, 'The local time is ' . date('n/j/Y g:i a') . "\n");
|
|
fclose($conn);
|
|
}
|
|
fclose($socket);
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
The example below shows how to act as a time server which can respond
|
|
to time queries as shown in an example on <function>stream_socket_client</function>.
|
|
<note>
|
|
<simpara>
|
|
Most systems require root access to create a server socket on a port
|
|
below 1024.
|
|
</simpara>
|
|
</note>
|
|
<example>
|
|
<title>Using UDP server sockets</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$socket = stream_socket_server("udp://127.0.0.1:1113", $errno, $errstr, STREAM_SERVER_BIND);
|
|
if (!$socket) {
|
|
die("$errstr ($errno)");
|
|
}
|
|
|
|
do {
|
|
$pkt = stream_socket_recvfrom($socket, 1, 0, $peer);
|
|
echo "$peer\n";
|
|
stream_socket_sendto($socket, date("D M j H:i:s Y\r\n"), 0, $peer);
|
|
} while ($pkt !== false);
|
|
|
|
?>
|
|
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
&ipv6.brackets;
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>stream_socket_client</function></member>
|
|
<member><function>stream_set_blocking</function></member>
|
|
<member><function>stream_set_timeout</function></member>
|
|
<member><function>fgets</function></member>
|
|
<member><function>fgetss</function></member>
|
|
<member><function>fwrite</function></member>
|
|
<member><function>fclose</function></member>
|
|
<member><function>feof</function></member>
|
|
<member><link linkend="ref.curl">Curl extension</link></member>
|
|
</simplelist>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|