radius-add-server.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: takagi Status: ready -->
<refentry xml:id="function.radius-add-server" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>radius_add_server</refname>
  <refpurpose>サーバーを追加する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>radius_add_server</methodname>
   <methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
   <methodparam><type>int</type><parameter>port</parameter></methodparam>
   <methodparam><type>string</type><parameter>secret</parameter></methodparam>
   <methodparam><type>int</type><parameter>timeout</parameter></methodparam>
   <methodparam><type>int</type><parameter>max_tries</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>radius_add_server</function> は複数回コールされることも
   ありえます。また、<function>radius_config</function> とともに
   使用されることでしょう。最大で 10 までのサーバーを指定できます。
   複数のサーバーが指定されると、有効なレスポンスを受信するか
   あるいは各サーバーへの接続回数が <parameter>max_tries</parameter>
   をこえるまでラウンドロビン形式でのアクセスを試みます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>radius_handle</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       <parameter>hostname</parameter> はサーバーのホストを
       FQDN あるいはドット区切りの IP アドレス形式で指定します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       <parameter>port</parameter> は、サーバーとの接続に使用する UDP
       ポートを指定します。0 を指定すると、このライブラリは
       ネットワークサービスデータベースから
       <systemitem class="resource">radius/udp</systemitem> あるいは
       <systemitem class="resource">radacct/udp</systemitem> サービスを
       検索し、見つかったポートを使用します。見つからなかった場合は
       標準の Radius ポート、すなわち認証には 1812、
       課金には 1813 を使用します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>secret</parameter></term>
     <listitem>
      <para>
       <parameter>secret</parameter> パラメータには、サーバーホストに
       対する共有秘密鍵が渡されます。Radius プロトコルは、共有秘密鍵の
       最初の 128 バイト以外を無視します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>timeout</parameter></term>
     <listitem>
      <para>
       <parameter>timeout</parameter> パラメータには、サーバーから
       応答を受信する際のタイムアウトを秒単位で指定します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>max_tries</parameter></term>
     <listitem>
      <para>
       結果が返ってこなかった場合に最大何回までリクエストを繰り返すかを
       <parameter>max_tries</parameter> に指定します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>radius_add_server</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
if (!radius_add_server($res, 'radius.example.com', 1812, 'testing123', 3, 3)) {
    echo 'RadiusError:' . radius_strerror($res). "\n<br>";
    exit;
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>radius_config</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
-->