Get Started with Open Swoole

Latest version: pecl install openswoole-4.11.1

Open Swoole is released as a PHP PECL (PHP Extension Community Library) extension (written in C++) and runs as a PHP CLI application, simply by running $ php server.php. You can read more about the PECL Repository and even browse extensions like Open Swoole. Using the PECL Repository is an official way to install additional extensions to the PHP language, you can think of it like an add-on/plug-in which gets compiled, installed and loaded with PHP.

There a are a few ways to install Open Swoole on different systems, at first it can seem complicated if you have never installed a PHP extension before but once you read the basics its actually really easy and simple.


Try it with Docker

Please check the Try Open Swoole with Docker guide.


Installation

Please check the prerequisites first and then the installation guide.

Open Swoole can be installed via PECL, Open Swoole PPA Repository (Ubuntu or Debian) or manually by compiling source code from GitHub.


Latest Updates

As with any open source project, Open Swoole always aims to provide the most reliable stability and the most powerful features in the latest released version. Please ensure as much as possible that you are using the latest version of Open Swoole and PHP.


Hello World

The following code is an Open Swoole HTTP Server returning a Hello World response:

<?php

use Swoole\Http\Server;
use Swoole\Http\Request;
use Swoole\Http\Response;

$server = new Swoole\HTTP\Server("127.0.0.1", 9501);

$server->on("Start", function(Server $server)
{
    echo "Swoole http server is started at http://127.0.0.1:9501\n";
});

$server->on("Request", function(Request $request, Response $response)
{
    $response->header("Content-Type", "text/plain");
    $response->end("Hello World\n");
});

$server->start();

To run the server, put the code into a file named server.php.

Then execute on the command line:

#!/bin/bash

# Start the HTTP server
$ php server.php

# On another terminal...
$ curl http://127.0.0.1:9501/

Interested with Open Swoole? Get Started with Open Swoole now!


Incompatibilities

Because Open Swoole uses multiple processes and uses a stateful program model, some PHP applications rely heavily on super globals which could lead to a process crash when using Open Swoole, so currently the following software is incompatible with Open Swoole:

  • Xdebug
  • phptrace
  • aop
  • molten
  • xhprof
  • Phalcon
  • BlackFire

You should read Open Swoole Tools for more information on alternatives.

Last updated on March 31, 2022