New functions: stream_socket_accept(), stream_socket_get_name()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@122576 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sara Golemon 2003-04-04 21:01:35 +00:00
parent 79528cd937
commit 15405dcc5d
2 changed files with 113 additions and 0 deletions

View file

@ -0,0 +1,66 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.stream-socket-accept">
<refnamediv>
<refname>stream_socket_accept</refname>
<refpurpose>
Accept a connection on a socket created by <function>stream_socket_server</function>
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>stream_socket_accept</methodname>
<methodparam><type>resource</type><parameter>server_socket</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>&amp;peername</parameter></methodparam>
</methodsynopsis>
<para>
Accept a connection on a socket previously created by
<function>stream_socket_server</function>. If
<parameter>timeout</parameter> is specified, the default
socket accept timeout will be overridden with the time
specified in seconds. The name (address) of the client
which connected will be passed back in <parameter>peername</parameter>
if included and available from the selected transport.
</para>
<simpara>
<parameter>peername</parameter> can also be determined later
using <function>stream_socket_get_name</function>.
</simpara>
<simpara>
If the call fails, it will return &false;.
</simpara>
<para>
See also <function>stream_socket_server</function>,
<function>stream_socket_get_name</function>,
<function>stream_set_blocking</function>,
<function>stream_set_timeout</function>,
<function>fgets</function>,
<function>fgetss</function>, <function>fputs</function>,
<function>fclose</function>, <function>feof</function>, and
the <link linkend="ref.curl">Curl extension</link>.
</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:"../../../../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
-->

View file

@ -0,0 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.stream-socket-get-name">
<refnamediv>
<refname>stream_socket_get_name</refname>
<refpurpose>Retrieve the name of the local or remote sockets</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>stream_socket_get_name</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>boolean</type><parameter>want_peer</parameter></methodparam>
</methodsynopsis>
<para>
Returns the local or remote name of a given socket connection.
If <parameter>want_peer</parameter> is set to &true; the remote
socket name will be returned, if it is set to &false; the local
socket name will be returned.
</para>
<para>
See also
<function>stream_socket_accept</function>
</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:"../../../../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
-->