php-doc-en/reference/stream/functions/stream-socket-accept.xml
Richard Quadling 0e80e8b7ba Use entity for failure.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@299445 c90b9560-bf6c-de11-be94-00142212c4b1
2010-05-18 11:00:11 +00:00

120 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stream-socket-accept" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stream_socket_accept</refname>
<refpurpose>Accept a connection on a socket created by <function>stream_socket_server</function></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>stream_socket_accept</methodname>
<methodparam><type>resource</type><parameter>server_socket</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>timeout</parameter><initializer>ini_get("default_socket_timeout")</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">peername</parameter></methodparam>
</methodsynopsis>
<para>
Accept a connection on a socket previously created by
<function>stream_socket_server</function>.
</para>
</refsect1>
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>server_socket</parameter></term>
<listitem>
<para>
The server socket to accept a connection from.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
Override the default socket accept timeout. Time should be given in
seconds.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>peername</parameter></term>
<listitem>
<para>
Will be set to the name (address) of the client which connected, if
included and available from the selected transport.
</para>
<note>
<para>
Can also be determined later using
<function>stream_socket_get_name</function>.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
Returns a stream to the accepted socket connection&return.falseforfailure;.
</para>
</refsect1><!-- }}} -->
<refsect1 role="notes"><!-- {{{ -->
&reftitle.notes;
<warning>
<para>
This function should not be used with UDP server sockets. Instead, use
<function>stream_socket_recvfrom</function> and
<function>stream_socket_sendto</function>.
</para>
</warning>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
<para>
<simplelist>
<member><function>stream_socket_server</function></member>
<member><function>stream_socket_get_name</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><xref linkend="ref.curl" /></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
-->