<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.socket-write" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>socket_write</refname>

<refpurpose>Escribe en un socket</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>int</type><type>false</type></type><methodname>socket_write</methodname>

<methodparam><type>Socket</type><parameter>socket</parameter></methodparam>

<methodparam><type>string</type><parameter>data</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

<function>socket_write</function> escribe en el socket

<parameter>socket</parameter> los datos del buffer

<parameter>data</parameter>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>socket</parameter></term>

<listitem>

<para>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>data</parameter></term>

<listitem>

<para>

El buffer a escribir.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>length</parameter></term>

<listitem>

<para>

El parámetro opcional <parameter>length</parameter> puede especificar

explícitamente el tamaño de los datos que deben ser escritos. Si esta

longitud es mayor que el tamaño de <parameter>data</parameter>,

será reducida automáticamente al tamaño de <parameter>data</parameter> mismo.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

<function>socket_write</function> devuelve el número de bytes que han

podido ser escritos en el socket&return.falseforfailure;.

El código de error generado puede ser obtenido llamando a la función

<function>socket_last_error</function>. Este código de error

puede ser pasado a la función <function>socket_strerror</function>

para obtener un mensaje de error, legible para humanos.

</para>

<note>

<para>

Es perfectamente válido que <function>socket_write</function> devuelva cero, lo que significa que ningún byte ha sido escrito. Asegúrese de utilizar el operador <literal>===</literal> para

comparar el retorno de la función con &false;, y detectar un

caso de error.

</para>

</note>

</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;

<row>

<entry>8.0.0</entry>

<entry>

<parameter>length</parameter> ahora es nullable.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

<function>socket_write</function> no escribe necesariamente todos

los bytes de <parameter>data</parameter> proporcionados. Es válido que, siguiendo ciertas

configuraciones de buffer de red, solo una cierta cantidad

de datos, incluso un byte, sea escrito, incluso si <parameter>data</parameter> es más grande.

Un ciclo debe ser utilizado para asegurarse de que el resto de <parameter>data</parameter>

sea transmitido.

</para>

</note>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>socket_accept</function></member>

<member><function>socket_bind</function></member>

<member><function>socket_connect</function></member>

<member><function>socket_listen</function></member>

<member><function>socket_read</function></member>

<member><function>socket_strerror</function></member>

</simplelist>

</para>

</refsect1>

</refentry>