1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.socket-create-listen" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>socket_create_listen</refname>
<refpurpose>Opens a socket on port to accept connections</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>Socket</type><type>false</type></type><methodname>socket_create_listen</methodname>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>backlog</parameter><initializer><constant>SOMAXCONN</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>socket_create_listen</function> creates a new <classname>Socket</classname> instance of
type <constant>AF_INET</constant> listening on <emphasis>all</emphasis>
local interfaces on the given port waiting for new connections.
</para>
<para>
This function is meant to ease the task of creating a new socket which
only listens to accept new connections.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
The port on which to listen on all interfaces.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>backlog</parameter></term>
<listitem>
<para>
The <parameter>backlog</parameter> parameter defines the maximum length
the queue of pending connections may grow to.
<constant>SOMAXCONN</constant> may be passed as
<parameter>backlog</parameter> parameter, see
<function>socket_listen</function> for more information.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>socket_create_listen</function> returns a new <classname>Socket</classname> instance
on success or &false; on error. The error code can be retrieved with
<function>socket_last_error</function>. This code may be passed to
<function>socket_strerror</function> to get a textual explanation of the
error.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
The default value of is now <constant>SOMAXCONN</constant>.
Previously it was <literal>128</literal>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
On success, this function returns a <classname>Socket</classname> instance now;
previously, a <type>resource</type> was returned.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
If you want to create a socket which only listens on a certain
interface you need to use <function>socket_create</function>,
<function>socket_bind</function> and <function>socket_listen</function>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>socket_create</function></member>
<member><function>socket_create_pair</function></member>
<member><function>socket_bind</function></member>
<member><function>socket_listen</function></member>
<member><function>socket_last_error</function></member>
<member><function>socket_strerror</function></member>
</simplelist>
</para>
</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
-->
|
