Files
doc-fr/reference/sockets/functions/socket-send.xml
George Peter Banyard b7784c08a3 Apply commit 14dc7c47365f2b71f6c907a5ba5bccf42534d5a9
Generate sockets methodsynopses based on stubs
2021-01-12 05:58:45 +00:00

159 lines
4.5 KiB
XML
Executable File

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14dc7c47365f2b71f6c907a5ba5bccf42534d5a9 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.socket-send" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>socket_send</refname>
<refpurpose>Envoie des données à un socket connecté</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>socket_send</methodname>
<methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
La fonction <function>socket_send</function> envoie
<parameter>length</parameter> octets au socket
<parameter>socket</parameter> depuis le buffer <parameter>data</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>socket</parameter></term>
<listitem>
<para>
Une instance de <classname>Socket</classname> créée par
<function>socket_create</function> ou <function>socket_accept</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Un buffer contenant les données qui seront envoyées sur l'hôte distant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
Le nombre d'octets qui doivent être envoyés à l'hôte distant
depuis le buffer <parameter>data</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
La valeur du paramètre <parameter>flags</parameter> peut être une
combinaison des drapeaux suivants, joints par un OU binaire
(<literal>|</literal>).
<table>
<title>Valeurs possibles pour <parameter>flags</parameter></title>
<tgroup cols="2">
<tbody>
<row>
<entry><constant>MSG_OOB</constant></entry>
<entry>
Traite les données OOB (out-of-band).
</entry>
</row>
<row>
<entry><constant>MSG_EOR</constant></entry>
<entry>
Indique un marqueur d'enregistrement. Les données envoyées
complètent l'enregistrement.
</entry>
</row>
<row>
<entry><constant>MSG_EOF</constant></entry>
<entry>
Termine l'envoi via le socket et inclue une notification
appropriée à la fin des données envoyées. Les données envoyées
complètent la transaction.
</entry>
</row>
<row>
<entry><constant>MSG_DONTROUTE</constant></entry>
<entry>
Ignore le routage, utilise une interface directe.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne le nombre d'octets envoyés, ou &false; si une erreur survient.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&sockets.changelog.socket-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>socket_sendto</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
-->