<?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>Schreibt in einen 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>

Die Funktion <function>socket_write</function> schreibt aus dem Puffer

<parameter>data</parameter> in den Socket <parameter>socket</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>

Der Puffer, dessen Inhalt geschrieben werden soll.

</para>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<para>

Mit dem optionalen Parameter <parameter>length</parameter> kann man

alternativ eine Anzahl von Bytes angeben, die in den Socket geschrieben

werden sollen. Falls diese Anzahl größer ist, als

<parameter>data</parameter>, wird sie stillschweigend auf die Größe von

<parameter>data</parameter> gekürzt.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Gibt die Anzahl der erfolgreich in den Socket geschriebenen Bytes zurück.

&return.falseforfailure;. Der Fehlercode kann mit der Funktion

<function>socket_last_error</function> ermittelt werden. Dieser Fehlercode

kann an die Funktion <function>socket_strerror</function> übergeben werden,

um eine textuelle Beschreibung des Fehlers zu erhalten.

</para>

<note>

<para>

Es ist durchaus möglich, dass <function>socket_write</function> den Wert 0

zurckgibt, was bedeutet, dass kein einziges Byte geschrieben wurde.

Vergewissern Sie sich, dass Sie den Operator <literal>===</literal>

benutzen, um im Falle eines Fehlers auf &false; zu testen.

</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> ist nun ein Nullable-Typ.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

<function>socket_write</function> schreibt nicht notwendigerweise alle

Bytes aus <parameter>data</parameter>. Abhängig von den Puffern im Netzwerk

usw. kann es sein, dass nur eine bestimmte Datenmenge, sogar nur ein Byte,

geschrieben wird, obwohl <parameter>data</parameter> größer ist.

Um sicherzustellen, dass der Rest von <parameter>data</parameter>

übertragen wird, muss eine Schleife verwendet werden.

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