php-doc-en/reference/sockets/functions/socket-addrinfo-lookup.xml
Christoph Michael Becker 4bff852af9 The added, but not filled in functions that pertain to the socket_addrinfo_* set.
-- 
Provided by anonymous 57081 (dave@mudsite.com)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345152 c90b9560-bf6c-de11-be94-00142212c4b1
2018-06-16 12:46:25 +00:00

96 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.socket-addrinfo-lookup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>socket_addrinfo_lookup</refname>
<refpurpose>Get array with contents of getaddrinfo about the given hostname</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>socket_addrinfo_lookup</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>service</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>hints</parameter></methodparam>
</methodsynopsis>
<para>
Lookup different ways we can connect to <parameter>host</parameter>. The returned array contains
a set of resources that we can bind to using <function>socket_addrinfo_bind</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<para>
Hostname to search.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>service</parameter></term>
<listitem>
<para>
The service to connect to. If service is a name, it is translated to the corresponding
port number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hints</parameter></term>
<listitem>
<para>
Hints provide criteria for selecting addresses returned. You may specify the
hints as defined by getadrinfo.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of AddrInfo resource handles that can be used with the other socket_addrinfo functions.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>socket_addrinfo_bind</function></member>
<member><function>socket_addrinfo_connect</function></member>
<member><function>socket_addrinfo_explain</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
-->