Files
doc-fr/reference/event/eventutil/setsocketoption.xml
2021-07-27 19:08:22 +03:00

135 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: da9d81816187b87c03a6cd92a3c3b833f039485c Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="eventutil.setsocketoption" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventUtil::setSocketOption</refname>
<refpurpose>Définit les options du socket</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<modifier>static</modifier>
<type>bool</type>
<methodname>EventUtil::setSocketOption</methodname>
<methodparam>
<type>mixed</type>
<parameter>socket</parameter>
</methodparam>
<methodparam>
<type>int</type>
<parameter>level</parameter>
</methodparam>
<methodparam>
<type>int</type>
<parameter>optname</parameter>
</methodparam>
<methodparam>
<type>mixed</type>
<parameter>optval</parameter>
</methodparam>
</methodsynopsis>
<para>
Définit les options du socket.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>socket</parameter>
</term>
<listitem>
<para>
Ressource de socket, flux, ou descripteur de fichier numérique associé avec
le socket.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>level</parameter>
</term>
<listitem>
<para>
Une constante <literal>EventUtil::SOL_*</literal>.
Spécifie le niveau du protocole dans lequel résident les options.
Par exemple, pour récupérer les options au niveau socket, le paramètre
<parameter>level</parameter> doit être positionné à la valeur
<constant>EventUtil::SOL_SOCKET</constant>. Les autres niveaux,
comme TCP, peuvent être utilisés en spécifiant le numéro du protocole
de ce niveau. Les numéros des protocoles peuvent être retrouvés
en utilisant la fonction <function>getprotobyname</function>. Voir
aussi les <link linkend="eventutil.constants">constantes EventUtil</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>optname</parameter>
</term>
<listitem>
<para>
Nom de l'option (type). A la même signification que le paramètre correspondant
de la fonction <function>socket_get_option</function>. Voir aussi les
<link linkend="eventutil.constants">constantes EventUtil</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>optval</parameter>
</term>
<listitem>
<para>
Accepte les mêmes valeurs que le paramètre
<parameter>optval</parameter> de la fonction
<function>socket_get_option</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<function>socket_get_option</function>
</member>
<member>
<function>socket_set_option</function>
</member>
</simplelist>
</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
-->