mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
98 lines
2.4 KiB
XML
98 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="eventutil.getsocketname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>EventUtil::getSocketName</refname>
|
|
<refpurpose>Retreives the current address to which the
|
|
socket is bound</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>static</modifier>
|
|
<type>bool</type>
|
|
<methodname>EventUtil::getSocketName</methodname>
|
|
<methodparam>
|
|
<type>mixed</type>
|
|
<parameter>socket</parameter>
|
|
</methodparam>
|
|
<methodparam>
|
|
<type>string</type>
|
|
<parameter role="reference">address</parameter>
|
|
</methodparam>
|
|
<methodparam choice="opt">
|
|
<type>mixed</type>
|
|
<parameter role="reference">port</parameter>
|
|
</methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Retreives the current address to which the
|
|
<parameter>socket</parameter>
|
|
is bound.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>socket</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Socket resource, stream or a file descriptor of a socket.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>address</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Output parameter. IP-address, or the UNIX domain socket path depending
|
|
on the socket address family.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>port</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Output parameter. The port the socket is bound to. Has no meaning for
|
|
UNIX domain sockets.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</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
|
|
-->
|