socket-addrinfo-lookup.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b0dba86b667cb30b72ef0a8cf42ea26d257ecfe4 Maintainer: mumumu Status: ready -->

<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>与えられたホスト名に関する getaddrinfo の内容を配列で取得する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>socket_addrinfo_lookup</methodname>
   <methodparam><type>string</type><parameter>host</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>service</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>hints</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>host</parameter> に接続できる別のやり方を探します。
   この関数が返す配列は <function>socket_addrinfo_bind</function>
   を使ってバインドできる <classname>AddressInfo</classname> クラスのインスタンスが含まれています。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>host</parameter></term>
    <listitem>
     <para>
      探す対象のホスト名
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>service</parameter></term>
    <listitem>
     <para>
      接続するサービス。service が数値形式の文字列の場合、
      ポート番号に翻訳されます。
      それ以外の場合、ネットワークサービス名に翻訳されます。
      これは、オペレーティングシステムによってポート番号にマップされます。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>hints</parameter></term>
    <listitem>
     <para>
      アドレスを選択する条件を与えるヒント。
      getaddrinfo によって定義されるヒントを指定できます。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>socket_addrinfo_<replaceable>*</replaceable></function> 関数で使える <classname>AddressInfo</classname> クラスのインスタンスの配列を返します。
   失敗した場合、&false; を返します。
  </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.0.0</entry>
      <entry>
       成功した場合に、この関数は
       <classname>AddressInfo</classname> クラスのインスタンスの配列を返すようになりました。
       これより前のバージョンでは、リソースの配列を返していました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>service</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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
-->