php-doc-en/reference/radius/functions/radius-send-request.xml
2021-06-18 09:43:49 +03:00

78 lines
2.2 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-send-request" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>radius_send_request</refname>
<refpurpose>Sends the request and waits for a reply</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>radius_send_request</methodname>
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
</methodsynopsis>
<para>
After the Radius request has been constructed, it is sent by
<function>radius_send_request</function>.
</para>
<para>
The <function>radius_send_request</function> function sends the request and
waits for a valid reply, retrying the defined servers in round-robin
fashion as necessary.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&radius.parameter.handle;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If a valid response is received, <function>radius_send_request</function>
returns the Radius code which specifies the type of the response. This will
typically be <constant>RADIUS_ACCESS_ACCEPT</constant>,
<constant>RADIUS_ACCESS_REJECT</constant>, or
<constant>RADIUS_ACCESS_CHALLENGE</constant>. If no valid response is
received, <function>radius_send_request</function> returns &false;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>radius_create_request</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
-->