PHP 8.4.1 Released!

socket_recvfrom

(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)

socket_recvfromEmpfängt Daten von einem Socket, egal, ob verbindungsorientiert oder nicht

Beschreibung

socket_recvfrom(
    Socket $socket,
    string &$data,
    int $length,
    int $flags,
    string &$address,
    int &$port = null
): int|false

Die Funktion socket_recvfrom() empfängt über den Socket socket length Bytes von address über den Port port (falls der Socket nicht vom Typ AF_UNIX ist) und liest sie in den Puffer data ein. socket_recvfrom() kann dazu verwendet werden, um Daten sowohl von verbundenen als auch unverbundenen Sockets zu lesen. Außerdem können ein oder mehrere Flags gesetzt werden, um das Verhalten dieser Funktion zu beeinflussen.

Die Parameter address und port müsssen als Referenz übergeben werden. Wenn der Socket verbindungslos ist, wird address auf die Internet-Protokolladresse des entfernten Host oder auf den Pfad zum UNIX-Socket gesetzt. Ist der Socket verbindungsorientiert, ist address null. Zusätzlich enthält der Parameter port den Port des entfernten Host, falls es sich um einen nicht verbundenen AF_INET oder AF_INET6-Socket handelt.

Hinweis: Diese Funktion ist binärsicher.

Parameter-Liste

socket

socket muss eine Socket-Instanz sein, die zuvor mit socket_create() erzeugt wurde.

data

Die empfangenen Daten werden in die Variable data eingelesen.

length

Bis zu length Bytes werden vom entfernten Host gelesen.

flags

Der Wert von flags kann eine beliebige Kombination der folgenden Flags sein, die mit dem binären OR (|) verknüpft werden.

Mögliche Werte für flags
Flag Beschreibung
MSG_OOB Verarbeite bandexterne Daten.
MSG_PEEK Lies Daten ab Anfang der Empfangs-Warteschlange, ohne die Daten aus der Warteschlange zu löschen.
MSG_WAITALL Blockiere so lange, bis mindestens length Daten gelesen wurden. Wenn jedoch ein Signal empfangen wurde oder der entfernte Host die Verbindung beendet, kann die Funktion auch weniger Daten zurückgeben.
MSG_DONTWAIT Wenn dieses Flag gesetzt ist, kehrt die Funktion zurück, auch wenn sie normalerweise blockieren würde.
address

Wenn der Socket vom Typ AF_UNIX ist, enthält address den Pfad zu einer Datei. Anderenfalls, bei nicht verbundenen Sockets, enthält address die IP-Adresse des entfernten Hosts oder null, falls der Socket verbindungsorientiert ist.

port

Dieses Argument gilt nur für Sockets vom Typ AF_INET und AF_INET6 und gibt den entfernten Port an, über den Daten empfangen werden. Falls der Socket verbindungsorientiert ist, ist port null.

Rückgabewerte

socket_recvfrom() gibt die Anzahl der empfangenen Bytes zurück oder false, falls ein Fehler auftrat. Der aktuelle Fehlercode kann mit socket_last_error() abgefragt werden. Dieser Fehlercode kann an die Funktion socket_strerror() übergeben werden, um eine textuelle Beschreibung des Fehlers zu erhalten.

Changelog

Version Beschreibung
8.0.0 socket ist nun eine Socket-Instanz; vorher war es eine resource.

Beispiele

Beispiel #1 socket_recvfrom()-Beispiel

<?php

$socket
= socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
socket_bind($socket, '127.0.0.1', 1223);

$from = '';
$port = 0;
socket_recvfrom($socket, $buf, 12, 0, $from, $port);

echo
"$buf von entfernter Adresse $from über den entfernten Port $port empfangen." . PHP_EOL;
?>

Dieses Beispiel erzeugt einen UDP-Socket über Port 1223 des Hosts 127.0.0.1 und gibt höchstens 12 Zeichen aus, die von einem entfernten Host empfangen wurden.

Siehe auch

  • socket_recv() - Empfängt Daten von einem verbundenen Socket
  • socket_send() - Sendet Daten an einen verbundenen Socket
  • socket_sendto() - Sendet eine Nachricht an einen Socket, egal ob dieser verbunden ist oder nicht
  • socket_create() - Erzeugt einen Socket (Endpunkt für die Kommunikation)

add a note

User Contributed Notes 4 notes

up
3
lorin dot weilenmann at gmail dot com
9 years ago
If you use socket_recvfrom on a UDP socket and combine it with the MSG_DONTWAIT flag, it will raise a PHP Warning if there is nothing to read. AFAIK, there is no way around that warning except suppressing it with @ (i.e. you cannot check if there is data before calling socket_recvfrom).
up
2
ply2attoetensen-project.com
7 years ago
MSG_DONTWAIT doesn't seem to exist in windows sockets. However socket_set_nonblock() seems to do the trick.
up
1
davide dot renzi at gmail dot com
12 years ago
Pay attention! On some PHP version the MSG_DONTWAIT flag is not defined (see https://bugs.php.net/bug.php?id=48326)
up
-3
jaggerwang at gmail dot com
17 years ago
I'm confused about the rerturn value of socket_recvfrom(), it said -1 when failed, but when I call like this:

if (($len = @socket_recvfrom($sock, $result, 32, 0, $ip, $port)) == -1) {
if ($this->_debug) {
echo "socket_read() failed: " . socket_strerror(socket_last_error()) . "\n";
}
return false;
}

variable $len = false, when I change the buffer length from 32 to 4096, it becomes right.
To Top