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

<!-- $Revision$ -->

<!-- EN-Revision: f80105b4fc1196bd8d5fecb98d686b580b1ff65d Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: yes -->

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

<refnamediv>

<refname>socket_read</refname>

<refpurpose>Lee datos de un socket</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>string</type><type>false</type></type><methodname>socket_read</methodname>

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

<methodparam><type>int</type><parameter>length</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PHP_BINARY_READ</constant></initializer></methodparam>

</methodsynopsis>

<para>

<function>socket_read</function> lee datos desde la instancia de

<classname>Socket</classname> <parameter>socket</parameter>, creada por

<function>socket_create</function> o <function>socket_accept</function>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

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

<listitem>

<para>

Una instancia de <classname>Socket</classname> creada por

<function>socket_create</function> o <function>socket_accept</function>.

</para>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<para>

Lee un máximo de <parameter>length</parameter> bytes. De lo contrario, puede utilizarse <literal>\r</literal>,

<literal>\n</literal> o <literal>\0</literal>

para terminar la lectura (según el valor elegido para

<parameter>mode</parameter>, ver a continuación).

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>mode</parameter></term>

<listitem>

<para>

El parámetro opcional <parameter>mode</parameter> puede tomar uno

de los siguientes valores constantes:

<itemizedlist>

<listitem>

<simpara>

<constant>PHP_BINARY_READ</constant> (Por omisión) - utiliza la función del sistema

<literal>recv()</literal>. Capaz de leer datos binarios.

</simpara>

</listitem>

<listitem>

<simpara>

<constant>PHP_NORMAL_READ</constant> - la lectura se detiene en <literal>\n</literal>

y <literal>\r</literal>

</simpara>

</listitem>

</itemizedlist>

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

<function>socket_read</function> devuelve los datos en forma de

string en caso de éxito, y &false; en caso contrario (incluyendo si el host remoto

ha cerrado la conexión). El código

de error generado puede obtenerse llamando a la función

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

puede pasarse a la función <function>socket_strerror</function>

para obtener un mensaje de error legible por humanos.

</para>

<note>

<para>

<function>socket_read</function> devuelve un string de longitud

cero (""), cuando ya no hay más datos para leer.

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

</tbody>

</tgroup>

</informaltable>

</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_last_error</function></member>

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

<member><function>socket_write</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

-->