Building WebSocket Servers with PHP

# CHAPTER 18

Building WebSocket Servers with PHP #

1. Introduction #

2. Learning Objectives #

• Understand why traditional PHP (LAMP stack) struggles with WebSockets.

• Explain the concept of an Event Loop (ReactPHP/Swoole).

• Identify the components of the Ratchet library.

• Write a basic CLI-based PHP WebSocket server.

3. Beginner-Friendly Explanation #

• Traditional PHP: A customer walks into a fast-food restaurant, places an order, gets their food, and leaves immediately. The cashier (PHP) forgets about them.

• WebSocket PHP: You need a bartender. The customer sits at the bar, orders a drink, and stays there for 3 hours, occasionally ordering more.

4. Real-World Examples #

• Ratchet: A highly popular PHP library based on ReactPHP. It is perfect for standard applications and works natively on any PHP setup.

• Swoole / OpenSwoole: A C-extension for PHP that runs at blazing speeds. Used by enterprise companies to handle millions of connections in PHP.

5. Step-by-Step Tutorial #

Step 1: Install Ratchet via Composer (composer require cboden/ratchet). Step 2: Create a PHP class that implements MessageComponentInterface. Step 3: Implement four required methods: onOpen, onMessage, onClose, onError. Step 4: Create a script (server.php) to instantiate the server and run it via the command line.

6. The Ratchet Chat Class #

7. PHP Ratchet Example #

<?php
namespace MyApp;

use Ratchet\MessageComponentInterface;
use Ratchet\ConnectionInterface;

class Chat implements MessageComponentInterface {
    protected $clients;

    public function __construct() {
        // SplObjectStorage is an array specifically designed to hold Objects safely
        $this->clients = new \SplObjectStorage;
    }

    public function onOpen(ConnectionInterface $conn) {
        // Store the new connection to send messages to later
        $this->clients->attach($conn);
        echo "New connection! ({$conn->resourceId})\n";
    }

    public function onMessage(ConnectionInterface $from, $msg) {
        $numRecv = count($this->clients) - 1;
        echo sprintf(&#039;Connection %d sending message "%s" to %d other connection%s' . "\n",
            $from->resourceId, $msg, $numRecv, $numRecv == 1 ? &#039;' : 's');

        // BROADCASTING: Send to everyone EXCEPT the sender
        foreach ($this->clients as $client) {
            if ($from !== $client) {
                $client->send($msg);
            }
        }
    }

    public function onClose(ConnectionInterface $conn) {
        // The connection is closed, remove it from our list
        $this->clients->detach($conn);
        echo "Connection {$conn->resourceId} has disconnected\n";
    }

    public function onError(ConnectionInterface $conn, \Exception $e) {
        echo "An error has occurred: {$e->getMessage()}\n";
        $conn->close();
    }
}

8. Running the Server #

<?php
use Ratchet\Server\IoServer;
use Ratchet\Http\HttpServer;
use Ratchet\WebSocket\WsServer;
use MyApp\Chat;

require dirname(__DIR__) . &#039;/vendor/autoload.php';

// Wrap our Chat logic inside WebSocket and HTTP handlers
$server = IoServer::factory(
    new HttpServer(
        new WsServer(
            new Chat()
        )
    ),
    8080 // Port number
);

echo "Server running on port 8080...\n";
$server->run();

To start the server, open your terminal and run: php server.php The terminal will hang indefinitely, listening for connections. Your server is alive!

9. Why SplObjectStorage? #

10. Best Practices #

• Supervisord: Because the server runs in the terminal, if it crashes, it stops working permanently. In production, use a tool like "Supervisor" (on Linux) to monitor the script and automatically restart it if it fails.

• Do not block the loop: If you run a slow MySQL query (sleep(5)) inside onMessage, it will freeze the server for 5 seconds. NO ONE else will be able to send messages during that time. Use Async queries or offload heavy work.

11. Common Mistakes #

• Putting the server in cPanel: Standard shared hosting (cPanel/Apache) aggressively kills any PHP script that runs for longer than 30-120 seconds. You need a VPS (Virtual Private Server) like DigitalOcean, Linode, or AWS with terminal access to run a persistent WebSocket daemon.

12. Mini Exercises #

1. 1. Look at the onMessage loop in Section 7. Notice the if ($from !== $client). This is the exact broadcasting logic we studied in Chapter 9!

13. Coding Challenges #

14. MCQs with Answers #

15. Interview Questions #

• Q: Explain why traditional Apache/PHP-FPM architecture is fundamentally unsuited for hosting WebSockets.

• Q: What is the purpose of SplObjectStorage in Ratchet?

16. FAQs #

17. Summary #

18. Next Chapter Recommendation #