L’extension socket implémente une interface bas niveau avec les fonctions de communication par socket, basées sur les sockets BSD si populaires, et fournit la possibilité de fonctionner aussi bien sous forme de client que de serveur.

Pour une interface socket cliente plus générique, voyez stream_socket_client(), stream_socket_server(), fsockopen() et pfsockopen().

Lorsque vous utilisez ces fonctions, il est important de vous rappeler que si de nombreuses fonctions ont le même nom que leur équivalent en langage C, elles ont souvent des déclarations différentes. Lisez attentivement les descriptions pour éviter des confusions.

Cela dit, ceux qui ne sont pas familiers avec la programmation par socket peuvent toujours trouver beaucoup de documentation dans les pages de manuel Unix appropriées, et il y a une grande quantité d’introductions en langage C sur le web, qui peuvent être facilement réutilisées, avec des adaptations mineures. UNIX Socket FAQ est un bon début.

Note : Cette extension a été déplacée dans le module PECL et ne sera plus intégrée dans PHP à partir de PHP 5.3.0.

Ces fonctions sont disponibles dans le module PHP standard, qui est toujours accessible.

Les fonctions de socket décrites ici font partie d’une extension PHP qui doit être activée lors de la compilation en utilisant l’option “–enable-sockets”, avec la commande configure.

Note : Le support des adresses IPv6 a été ajouté en PHP 5.0.

Cette extension ne définit aucune directive de configuration.

Cette extension ne définit aucune ressource.

Ces constantes sont définies par cette extension, et ne sont disponibles que si cette extension a été compilée avec PHP, ou bien chargée au moment de l’exécution.

“AF_UNIX” (entier)

“AF_INET” (entier)

“AF_INET6” (entier)

“SOCK_STREAM” (entier)

“SOCK_DGRAM” (entier)

“SOCK_RAW” (entier)

“SOCK_SEQPACKET” (entier)

“SOCK_RDM” (entier)

“MSG_OOB” (entier)

“MSG_WAITALL” (entier)

“MSG_PEEK” (entier)

“MSG_DONTROUTE” (entier)

“SO_DEBUG” (entier)

“SO_REUSEADDR” (entier)

“SO_KEEPALIVE” (entier)

“SO_DONTROUTE” (entier)

“SO_LINGER” (entier)

“SO_BROADCAST” (entier)

“SO_OOBINLINE” (entier)

“SO_SNDBUF” (entier)

“SO_RCVBUF” (entier)

“SO_SNDLOWAT” (entier)

“SO_RCVLOWAT” (entier)

“SO_SNDTIMEO” (entier)

“SO_RCVTIMEO” (entier)

“SO_TYPE” (entier)

“SO_ERROR” (entier)

“SOL_SOCKET” (entier)

“PHP_NORMAL_READ” (entier)

“PHP_BINARY_READ” (entier)

“SOL_TCP” (entier)

“SOL_UDP” (entier)

L’extension socket a été écrite pour fournir une interface utilisable avec les puissantes sockets fournies par BSD. Un soin particulier a été apporté pour que les fonctions soient aussi efficaces sous Unix que sous Windows. Presque toutes les fonctions de sockets peuvent échouer dans certaines circonstances, et émettent ainsi un message d’alerte “E_WARNING” décrivant l’erreur. Parfois, cela ne se fait pas selon les souhaits du développeur. Par exemple, la fonction socket_read() peut tout à coup émettre un message “E_WARNING” car la connexion a été inopinément interrompue. Il est commun de supprimer les erreurs avec l’opérateur “@” et de traiter les erreurs avec la fonction socket_last_error(), au niveau de l’application. Vous pouvez appeler socket_strerror() avec le code d’erreur pour connaître le message d’erreur, humainement lisible. Reportez-vous à leur description pour plus de détails.

Note : Les messages “E_WARNING” générés par l’extension socket sont en anglais, mais ils s’afficheront en fonction de la configuration locale (”LC_MESSAGES”):
| " Warning - socket_bind() unable to bind address [98]: Die Adresse wird bereits verwendet " |

Cet exemple montre comment créer un serveur simple. Changez les variables “address” et “port” pour vous adapter à votre configuration, et exécutez-le. Vous pourrez alors vous connecter au serveur avec une commande comme ceci : telnet 192.168.1.53 10000 (en supposant que l’adresse et le port correspondent à votre configuration). Tout ce que vous saisissez après cela sera envoyé au serveur, et affiché en retour. Pour vous déconnecter, tapez ‘quit’.

#!/usr/local/bin/php -q
<?php
error_reporting(E_ALL);
 
/* Autorise l'exécution infinie du script, en attente de connexion. */
set_time_limit(0);
 
/* Active le vidage implicite des buffers de sortie, pour que nous
 * puissions voir ce que nous lisons au fur et à mesure. */
ob_implicit_flush();
 
$address = '192.168.1.53';
$port = 10000;
 
if (($sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) === false) {
    echo "socket_create() a échoué : raison : " . socket_strerror(socket_last_error()) . "\n";
}
 
if (socket_bind($sock, $address, $port) === false) {
    echo "socket_bind() a échoué : raison : " . socket_strerror(socket_last_error($sock)) . "\n";
}
 
if (socket_listen($sock, 5) === false) {
    echo "socket_listen() a échoué : raison : " . socket_strerror(socket_last_error($sock)) . "\n";
}
 
do {
    if (($msgsock = socket_accept($sock)) === false {
        echo "socket_accept() a échoué : raison : " . socket_strerror(socket_last_error($sock)) . "\n";
        break;
    }
    /* Send instructions. */
    $msg = "\Bienvenue sur le serveur de test PHP.\n" .
        "Pour quitter, tapez 'quit'. Pour éteindre le serveur, tapez 'shutdown'.\n";
    socket_write($msgsock, $msg, strlen($msg));
 
    do {
        if (false === ($buf = socket_read($msgsock, 2048, PHP_NORMAL_READ))) {
            echo "socket_read() a échoué : raison : " . socket_strerror(socket_last_error($msgsock)) . "\n";
            break 2;
        }
        if (!$buf = trim($buf)) {
            continue;
        }
        if ($buf == 'quit') {
            break;
        }
        if ($buf == 'shutdown') {
            socket_close($msgsock);
            break 2;
        }
        $talkback = "PHP: You said '$buf'.\n";
        socket_write($msgsock, $talkback, strlen($talkback));
        echo "$buf\n";
    } while (true);
    socket_close($msgsock);
} while (true);
 
socket_close($sock);
?>

Cet exemple implémente un client HTTP simple. Il se connecte simplement à une page, envoie une requête “HEAD”, affiche le résultat et se termine.

<?php
error_reporting(E_ALL);
 
echo "<h2>Connexion TCP/IP</h2>\n";
 
/* Lit le port du service WWW. */
$service_port = getservbyname('www', 'tcp');
 
/* Lit l'adresse IP du serveur de destination */
$address = gethostbyname('www.example.com');
 
/* Cree une socket TCP/IP. */
$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
if ($socket === false) {
    echo "socket_create() a échoué : raison :  " . socket_strerror(socket_last_error()) . "\n";
} else {
    echo "OK.\n";
}
 
echo "Essai de connexion à '$address' sur le port '$service_port'...";
$result = socket_connect($socket, $address, $service_port);
if ($socket === false) {
    echo "socket_connect() a échoué : raison : ($result) " . socket_strerror(socket_last_error($socket)) . "\n";
} else {
    echo "OK.\n";
}
 
$in = "HEAD / HTTP/1.0\r\n\r\n";
$in .= "Host: www.example.com\r\n";
$in .= "Connection: Close\r\n\r\n";
$out = '';
 
echo "Envoi de la requête HTTP HEAD...";
socket_write($socket, $in, strlen($in));
echo "OK.\n";
 
echo "Lire la réponse : \n\n";
while ($out = socket_read($socket, 2048)) {
    echo $out;
}
 
echo "Fermeture de la socket...";
socket_close($socket);
echo "OK.\n\n";
?>

Table des matières

socket_accept – Accepte une connexion sur une socketsocket_bind – Lie un nom à une socketsocket_clear_error – Efface toutes les erreurs précédemment générées par une socketsocket_close – Ferme une socketsocket_connect – Crée une connexion sur une socketsocket_create_listen – Ouvre une socket sur un port pour accepter les connexionssocket_create_pair – Crée une paire de sockets identiques et les stocke dans un tableausocket_create – Crée une socketsocket_get_option – Lit les options de la socketsocket_getpeername – Interroge l’autre extrémité de la communicationsocket_getsockname – Interroge la socket localesocket_last_error – Lit la dernière erreur générée par une socketsocket_listen – Attend une connexion sur une socketsocket_read – Lit des données d’une socketsocket_recv – Reçoit des données d’une socket connectéesocket_recvfrom – Reçoit des données d’une socket, connectée ou pas socket_select –  Exécute l’appel système select() un tableau de sockets avec une durée d’expiration socket_send – Envoie des données à une socket connectéesocket_sendto –  Envoie une message à une socket, qu’elle soit connectée ou pas socket_set_block –  Met la socket en mode bloquant socket_set_nonblock – Sélectionne le mode non bloquant d’un descripteur de fichiersocket_set_option – Modifie les options de socketsocket_shutdown – Eteint une socket en lecture et/ou écrituresocket_strerror – Retourne une chaîne décrivant un message d’erreursocket_write – Ecrit dans une socket