Socket Functions

Introduction

The socket extension implements a low-level interface to the socket communication functions based on the popular BSD sockets, providing the possibility to act as a socket server as well as a client.

For a more generic client-side socket interface, see stream_socket_client(), stream_socket_server(), fsockopen(), and pfsockopen().

When using these functions, it is important to remember that while many of them have identical names to their C counterparts, they often have different declarations. Please be sure to read the descriptions to avoid confusion.

Those unfamiliar with socket programming can find a lot of useful material in the appropriate Unix man pages, and there is a great deal of tutorial information on socket programming in C on the web, much of which can be applied, with slight modifications, to socket programming in PHP. The » Unix Socket FAQ might be a good start.

Note:

This extension has been moved to the » PECL repository and is no longer bundled with PHP as of PHP 5.3.0.

Requirements

No external libraries are needed to build this extension.

Installation

The socket functions described here are part of an extension to PHP which must be enabled at compile time by giving the --enable-sockets option to configure.

Note:

IPv6 Support was added with PHP 5.0.0.

Runtime Configuration

This extension has no configuration directives defined in php.ini.

Resource Types

socket_accept(), socket_create_listen() and socket_create() return socket recources.

Predefined Constants

The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.

AF_UNIX (integer)
AF_INET (integer)
AF_INET6 (integer)
SOCK_STREAM (integer)
SOCK_DGRAM (integer)
SOCK_RAW (integer)
SOCK_SEQPACKET (integer)
SOCK_RDM (integer)
MSG_OOB (integer)
MSG_WAITALL (integer)
MSG_PEEK (integer)
MSG_DONTROUTE (integer)
MSG_EOR (integer)
MSG_EOF (integer)
SO_DEBUG (integer)
SO_REUSEADDR (integer)
SO_KEEPALIVE (integer)
SO_DONTROUTE (integer)
SO_LINGER (integer)
SO_BROADCAST (integer)
SO_OOBINLINE (integer)
SO_SNDBUF (integer)
SO_RCVBUF (integer)
SO_SNDLOWAT (integer)
SO_RCVLOWAT (integer)
SO_SNDTIMEO (integer)
SO_RCVTIMEO (integer)
SO_TYPE (integer)
SO_ERROR (integer)
SOL_SOCKET (integer)
PHP_NORMAL_READ (integer)
PHP_BINARY_READ (integer)
SOL_TCP (integer)
SOL_UDP (integer)

Socket Errors

The socket extension was written to provide a usable interface to the powerful BSD sockets. Care has been taken that the functions work equally well on Win32 and Unix implementations. Almost all of the sockets functions may fail under certain conditions and therefore emit an E_WARNING message describing the error. Sometimes this doesn't happen to the desire of the developer. For example the function socket_read() may suddenly emit an E_WARNING message because the connection broke unexpectedly. It's common to suppress the warning with the @-operator and catch the error code within the application with the socket_last_error() function. You may call the socket_strerror() function with this error code to retrieve a string describing the error. See their description for more information.

Note:

The E_WARNING messages generated by the socket extension are in English though the retrieved error message will appear depending on the current locale (LC_MESSAGES):

copy to clipboard

Warning - socket_bind() unable to bind address [98]: Die Adresse wird bereits verwendet ?>

Examples

Example 2289. Socket example: Simple TCP/IP server

This example shows a simple talkback server. Change the address and port variables to suit your setup and execute. You may then connect to the server with a command similar to: telnet 192.168.1.53 10000 (where the address and port match your setup). Anything you type will then be output on the server side, and echoed back to you. To disconnect, enter 'quit'.

copy to clipboard

#!/usr/local/bin/php -q
<?php

error_reporting(E_ALL);

/* Allow the script to hang around waiting for connections. */
set_time_limit(0);

/* Turn on implicit output flushing so we see what we're getting

 * as it comes in. */
ob_implicit_flush();

$address = '192.168.1.53';
$port = 10000;


if (($sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) === false) {

    echo "socket_create() failed: reason: " . socket_strerror(socket_last_error()) . "\n";

}


if (socket_bind($sock, $address, $port) === false) {

    echo "socket_bind() failed: reason: " . socket_strerror(socket_last_error($sock)) . "\n";

}


if (socket_listen($sock, 5) === false) {

    echo "socket_listen() failed: reason: " . socket_strerror(socket_last_error($sock)) . "\n";

}


do {

    if (($msgsock = socket_accept($sock)) === false) {

        echo "socket_accept() failed: reason: " . socket_strerror(socket_last_error($sock)) . "\n";

        break;

    }

    /* Send instructions. */

    $msg = "\nWelcome to the PHP Test Server. \n" .

        "To quit, type 'quit'. To shut down the server type 'shutdown'.\n";

    socket_write($msgsock, $msg, strlen($msg));


    do {

        if (false === ($buf = socket_read($msgsock, 2048, PHP_NORMAL_READ))) {

            echo "socket_read() failed: reason: " . 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);
?>

Example 2290. Socket example: Simple TCP/IP client

This example shows a simple, one-shot HTTP client. It simply connects to a page, submits a HEAD request, echoes the reply, and exits.

copy to clipboard

<?php

error_reporting(E_ALL);


echo "<h2>TCP/IP Connection</h2>\n";

/* Get the port for the WWW service. */
$service_port = getservbyname('www', 'tcp');

/* Get the IP address for the target host. */
$address = gethostbyname('www.example.com');

/* Create a TCP/IP socket. */
$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);

if ($socket === false) {

    echo "socket_create() failed: reason: " . socket_strerror(socket_last_error()) . "\n";

} else {

    echo "OK.\n";

}


echo "Attempting to connect to '$address' on port '$service_port'...";
$result = socket_connect($socket, $address, $service_port);

if ($result === false) {

    echo "socket_connect() failed.\nReason: ($result) " . socket_strerror(socket_last_error($socket)) . "\n";

} else {

    echo "OK.\n";

}

$in = "HEAD / HTTP/1.1\r\n";
$in .= "Host: www.example.com\r\n";
$in .= "Connection: Close\r\n\r\n";
$out = '';


echo "Sending HTTP HEAD request...";
socket_write($socket, $in, strlen($in));

echo "OK.\n";


echo "Reading response:\n\n";

while ($out = socket_read($socket, 2048)) {

    echo $out;

}


echo "Closing socket...";
socket_close($socket);

echo "OK.\n\n";
?>

Table of Contents

socket_accept — Accepts a connection on a socket
socket_bind — Binds a name to a socket
socket_clear_error — Clears the error on the socket or the last error code
socket_close — Closes a socket resource
socket_connect — Initiates a connection on a socket
socket_create_listen — Opens a socket on port to accept connections
socket_create_pair — Creates a pair of indistinguishable sockets and stores them in an array
socket_create — Create a socket (endpoint for communication)
socket_get_option — Gets socket options for the socket
socket_getpeername — Queries the remote side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type
socket_getsockname — Queries the local side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type
socket_last_error — Returns the last error on the socket
socket_listen — Listens for a connection on a socket
socket_read — Reads a maximum of length bytes from a socket
socket_recv — Receives data from a connected socket
socket_recvfrom — Receives data from a socket whether or not it is connection-oriented
socket_select — Runs the select() system call on the given arrays of sockets with a specified timeout
socket_send — Sends data to a connected socket
socket_sendto — Sends a message to a socket, whether it is connected or not
socket_set_block — Sets blocking mode on a socket resource
socket_set_nonblock — Sets nonblocking mode for file descriptor fd
socket_set_option — Sets socket options for the socket
socket_shutdown — Shuts down a socket for receiving, sending, or both
socket_strerror — Return a string describing a socket error
socket_write — Write to a socket

Code Examples / Notes » ref.sockets

I have searched long and hard for a ping script that does NOT use EXEC() or SYSTEM(). So far, I have found nothing, so I decided to write my own, which was a task to say the least. First off, I would like to thank Khaless for their checksum function, converting it from C looked like a task in itself. Here is the class I wrote <?php class Net_Ping { var $icmp_socket; var $request; var $request_len; var $reply; var $errstr; var $time; var $timer_start_time; function Net_Ping() { $this->icmp_socket = socket_create(AF_INET, SOCK_RAW, 1); socket_set_block($this->icmp_socket); } function ip_checksum($data) { for($i=0;$i<strlen($data);$i += 2) { if($data[$i+1]) $bits = unpack('n*',$data[$i].$data[$i+1]); else $bits = unpack('C*',$data[$i]); $sum += $bits[1]; } while ($sum>>16) $sum = ($sum & 0xffff) + ($sum >> 16); $checksum = pack('n1',~$sum); return $checksum; } function start_time() { $this->timer_start_time = microtime(); } function get_time($acc=2) { // format start time $start_time = explode (" ", $this->timer_start_time); $start_time = $start_time[1] + $start_time[0]; // get and format end time $end_time = explode (" ", microtime()); $end_time = $end_time[1] + $end_time[0]; return number_format ($end_time - $start_time, $acc); } function Build_Packet() { $data = "abcdefghijklmnopqrstuvwabcdefghi"; // the actual test data $type = "\x08"; // 8 echo message; 0 echo reply message $code = "\x00"; // always 0 for this program $chksm = "\x00\x00"; // generate checksum for icmp request $id = "\x00\x00"; // we will have to work with this later $sqn = "\x00\x00"; // we will have to work with this later // now we need to change the checksum to the real checksum $chksm = $this->ip_checksum($type.$code.$chksm.$id.$sqn.$data); // now lets build the actual icmp packet $this->request = $type.$code.$chksm.$id.$sqn.$data; $this->request_len = strlen($this->request); } function Ping($dst_addr,$timeout=5,$percision=3) { // lets catch dumb people if ((int)$timeout <= 0) $timeout=5; if ((int)$percision <= 0) $percision=3; // set the timeout socket_set_option($this->icmp_socket, SOL_SOCKET, // socket level SO_RCVTIMEO, // timeout option array( "sec"=>$timeout, // Timeout in seconds "usec"=>0 // I assume timeout in microseconds ) ); if ($dst_addr) { if (@socket_connect($this->icmp_socket, $dst_addr, NULL)) { } else { $this->errstr = "Cannot connect to $dst_addr"; return FALSE; } $this->Build_Packet(); $this->start_time(); socket_write($this->icmp_socket, $this->request, $this->request_len); if (@socket_recv($this->icmp_socket, &$this->reply, 256, 0)) { $this->time = $this->get_time($percision); return $this->time; } else { $this->errstr = "Timed out"; return FALSE; } } else { $this->errstr = "Destination address not specified"; return FALSE; } } } $ping = new Net_Ping; $ping->ping("www.google.ca"); if ($ping->time) echo "Time: ".$ping->time; else echo $ping->errstr; ?> Hope this saves some troubles. noSanity

Below is a simple forked daemon I wrote in PHP. I haven't seen one yet anywhere else, so I thought some people might be wondering how to do it. Execute with php -q <file> <?PHP /* PHP forked daemon Standalone PHP binary must be compiled with --enable-sockets and --enable-pcntl Dave M. -2002 Online Services USA */ function sig_handler($signo) { switch($signo) { case SIGTERM: // handle shutdown tasks exit; break; case SIGHUP: // handle restart tasks break; case SIGUSR1: print "Caught SIGUSR1...\n"; break; case SIGCHLD: while( pcntl_waitpid(-1,$status,WNOHANG)>0 ) { } break; case SIGINT: exit; default: // not implemented yet... break; } } function interact($sock) { // Custom code goes here... e.g: socket_read() socket_write()... } function become_daemon() { $child = pcntl_fork(); if($child) { exit; // kill parent } posix_setsid(); // become session leader chdir("/"); umask(0); // clear umask return posix_getpid(); } function open_pid_file($file) { if(file_exists($file)) { $fp = fopen($file,"r"); $pid = fgets($fp,1024); fclose($fp); if(posix_kill($pid,0)) { print "Server already running with PID: $pid\n"; exit; } print "Removing PID file for defunct server process $pid\n"; if(!unlink($file)) { print "Cannot unlink PID file $file\n"; exit; } } if($fp = fopen($file,"w")) { return $fp; } else { print "Unable to open PID file $file for writing...\n"; exit; } } function change_identity($uid,$gid) { global $pid_file; if(!posix_setgid($gid)) { print "Unable to setgid to $gid!\n"; unlink($pid_file); exit; } if(!posix_setuid($uid)) { print "Unable to setuid to $uid!\n"; unlink($pid_file); exit; } } error_reporting (4); set_time_limit (0); ob_implicit_flush (); $pid_file = '/tmp/php_daemon.pid'; $underpriv_uid = '99'; // uid 99 == user nobody, at least on my system. $underpriv_gid = '99'; $port = 10000; $address = 0; // 0 binds to all addresses, may not work on fbsd $quit = 0; pcntl_signal(SIGCHLD, "sig_handler"); pcntl_signal(SIGTERM, "sig_handler"); pcntl_signal(SIGINT, "sig_handler"); $fh = open_pid_file($pid_file); if (($sock = socket_create (AF_INET, SOCK_STREAM, 0)) < 0) { print "socket_create() failed: reason: " . socket_strerror ($sock) . "\n"; } if (($ret = socket_bind ($sock, $address, $port)) < 0) { print "socket_bind() failed: reason: " . socket_strerror ($ret) . "\n"; } if (($ret = socket_listen ($sock, 0)) < 0) { print "socket_listen() failed: reason: " . socket_strerror ($ret) . "\n"; } change_identity($underpriv_uid,$underpriv_gid); print "Server ready. Waiting for connections.....\n"; $pid = become_daemon(); fputs($fh,$pid); fclose($fh); while(!$quit) { if (($connection = socket_accept($sock)) < 0) { next; } if( ($child = pcntl_fork()) == -1 ) { print "Could not fork!!\n"; print "Dying...\n"; $quit++; } elseif($child == 0) { socket_close($sock); interact($connection); exit; } socket_close($connection); } if(posix_getpid() == $pid) { unlink($pid_file); }

Socket Functions

Introduction

Requirements

Installation

Runtime Configuration

Resource Types

Predefined Constants

Socket Errors

Examples

Example 2289. Socket example: Simple TCP/IP server

Example 2290. Socket example: Simple TCP/IP client

Code Examples / Notes » ref.sockets

Change Language