mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 21:38:56 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
153 lines
4.6 KiB
XML
153 lines
4.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- splitted from ./en/functions/radius.xml, last change in rev 1.9 -->
|
|
<refentry xml:id="function.radius-add-server" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>radius_add_server</refname>
|
|
<refpurpose>Adds a server</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> may be called multiple times, and it
|
|
may be used together with <function>radius_config</function>. At most 10
|
|
servers may be specified. When multiple servers are given, they are tried
|
|
in round-robin fashion until a valid response is received, or until each
|
|
server's <parameter>max_tries</parameter> limit has been reached.
|
|
</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>
|
|
The <parameter>hostname</parameter> parameter specifies the server host,
|
|
either as a fully qualified domain name or as a dotted-quad IP address
|
|
in text form.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>port</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>port</parameter> specifies the UDP port to contact on
|
|
the server. If port is given as 0, the library looks up the
|
|
<systemitem class="resource">radius/udp</systemitem> or
|
|
<systemitem class="resource">radacct/udp</systemitem> service in the
|
|
network services database, and uses the port found there. If no entry
|
|
is found, the library uses the standard Radius ports, 1812 for
|
|
authentication and 1813 for accounting.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>secret</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The shared secret for the server host is passed to the
|
|
<parameter>secret</parameter> parameter. The Radius protocol ignores
|
|
all but the leading 128 bytes of the shared secret.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>timeout</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The timeout for receiving replies from the server is passed to the
|
|
<parameter>timeout</parameter> parameter, in units of seconds.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>max_tries</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The maximum number of repeated requests to make before giving up is
|
|
passed into the <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> example</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
|
|
-->
|
|
|