Swoole is an event-driven, asynchronous, coroutine-based concurrency library with high performance for PHP.

⚙️ Quick Start

docker run --rm phpswoole/swoole"php --ri swoole"

HTTP Service

$http =newSwoole\Http\Server('127.0.0.1',9501);$http->set(['hook_flags' =>SWOOLE_HOOK_ALL]);$http->on('request',function ($request,$response) {$result = [];    Co::join([go(function ()use (&$result) {$result['google'] =file_get_contents("https://www.google.com/");        }),go(function ()use (&$result) {$result['taobao'] =file_get_contents("https://www.taobao.com/");        })    ]);$response->end(json_encode($result));});$http->start();

Concurrency

Co\run(function() {Co\go(function() {while(1) {sleep(1);$fp =stream_socket_client("tcp://127.0.0.1:8000",$errno,$errstr,30);echofread($fp,8192),PHP_EOL;        }    });Co\go(function() {$fp =stream_socket_server("tcp://0.0.0.0:8000",$errno,$errstr,STREAM_SERVER_BIND |STREAM_SERVER_LISTEN);while(1) {$conn =stream_socket_accept($fp);fwrite($conn,'The local time is' .date('n/j/Y g:i a'));        }    });Co\go(function() {$redis =newRedis();$redis->connect('127.0.0.1',6379);while(true) {$redis->subscribe(['test'],function ($instance,$channelName,$message) {echo'New redis message:'.$channelName,"==>",$message,PHP_EOL;            });        }    });Co\go(function() {$redis =newRedis();$redis->connect('127.0.0.1',6379);$count =0;while(true) {sleep(2);$redis->publish('test','hello, world, count='.$count++);        }    });});

Runtime Hook

Supported extension/functions

🛠 Develop & Discussion

💎 Awesome Swoole

✨ Event-based

⚡ Coroutine

MySQL

$s =microtime(true);Co\run(function() {for ($c =100;$c--;) {go(function () {$mysql =newSwoole\Coroutine\MySQL;$mysql->connect(['host' =>'127.0.0.1','user' =>'root','password' =>'root','database' =>'test'            ]);$statement =$mysql->prepare('SELECT * FROM `user`');for ($n =100;$n--;) {$result =$statement->execute();assert(count($result) >0);            }        });    }});echo'use' . (microtime(true) -$s) .' s';

Mixed server

functiontcp_pack(string$data):string{returnpack('N',strlen($data)) .$data;}functiontcp_unpack(string$data):string{returnsubstr($data,4,unpack('N',substr($data,0,4))[1]);}$tcp_options = ['open_length_check' =>true,'package_length_type' =>'N','package_length_offset' =>0,'package_body_offset' =>4];

$server =newSwoole\WebSocket\Server('127.0.0.1',9501,SWOOLE_BASE);$server->set(['open_http2_protocol' =>true]);// http && http2$server->on('request',function (Swoole\Http\Request$request,Swoole\Http\Response$response) {$response->end('Hello' .$request->rawcontent());});// websocket$server->on('message',function (Swoole\WebSocket\Server$server,Swoole\WebSocket\Frame$frame) {$server->push($frame->fd,'Hello' .$frame->data);});// tcp$tcp_server =$server->listen('127.0.0.1',9502,SWOOLE_TCP);$tcp_server->set($tcp_options);$tcp_server->on('receive',function (Swoole\Server$server,int$fd,int$reactor_id,string$data) {$server->send($fd,tcp_pack('Hello' .tcp_unpack($data)));});$server->start();

Coroutine clients

go(function () {// http$http_client =newSwoole\Coroutine\Http\Client('127.0.0.1',9501);assert($http_client->post('/','Swoole Http'));var_dump($http_client->body);// websocket$http_client->upgrade('/');$http_client->push('Swoole Websocket');var_dump($http_client->recv()->data);});go(function () {// http2$http2_client =newSwoole\Coroutine\Http2\Client('localhost',9501);$http2_client->connect();$http2_request =newSwoole\Http2\Request;$http2_request->method ='POST';$http2_request->data ='Swoole Http2';$http2_client->send($http2_request);$http2_response =$http2_client->recv();var_dump($http2_response->data);});go(function ()use ($tcp_options) {// tcp$tcp_client =newSwoole\Coroutine\Client(SWOOLE_TCP);$tcp_client->set($tcp_options);$tcp_client->connect('127.0.0.1',9502);$tcp_client->send(tcp_pack('Swoole Tcp'));var_dump(tcp_unpack($tcp_client->recv()));});

Channel

The simplest example of a connection pool

class RedisPool{/**@var \Swoole\Coroutine\Channel */protected$pool;/**     * RedisPool constructor.     * @param int $size max connections     */publicfunction__construct(int$size =100)    {$this->pool =new \Swoole\Coroutine\Channel($size);for ($i =0;$i <$size;$i++) {$redis =new \Swoole\Coroutine\Redis();$res =$redis->connect('127.0.0.1',6379);if ($res ==false) {thrownew \RuntimeException("failed to connect redis server.");            }else {$this->put($redis);            }        }    }publicfunctionget():\Swoole\Coroutine\Redis    {return$this->pool->pop();    }publicfunctionput(\Swoole\Coroutine\Redis$redis)    {$this->pool->push($redis);    }publicfunctionclose():void    {$this->pool->close();$this->pool =null;    }}go(function () {$pool =newRedisPool();// max concurrency num is more than max connections// but it's no problem, channel will help you with schedulingfor ($c =0;$c <1000;$c++) {go(function ()use ($pool,$c) {for ($n =0;$n <100;$n++) {$redis =$pool->get();assert($redis->set("awesome-{$c}-{$n}",'swoole'));assert($redis->get("awesome-{$c}-{$n}") ==='swoole');assert($redis->delete("awesome-{$c}-{$n}"));$pool->put($redis);            }        });    }});

Producer and consumers

go(function () {// User: I need you to bring me some information back.// Channel: OK! I will be responsible for scheduling.$channel =newSwoole\Coroutine\Channel;go(function ()use ($channel) {// Coroutine A: Ok! I will show you the github addr info$addr_info = Co::getaddrinfo('github.com');$channel->push(['A',json_encode($addr_info,JSON_PRETTY_PRINT)]);    });go(function ()use ($channel) {// Coroutine B: Ok! I will show you what your code look like$mirror = Co::readFile(__FILE__);$channel->push(['B',$mirror]);    });go(function ()use ($channel) {// Coroutine C: Ok! I will show you the date$channel->push(['C',date(DATE_W3C)]);    });for ($i =3;$i--;) {list($id,$data) =$channel->pop();echo"From{$id}:\n{$data}\n";    }// User: Amazing, I got every information at earliest time!});

Timer

$id =Swoole\Timer::tick(100,function () {echo"⚙️ Do something...\n";});Swoole\Timer::after(500,function ()use ($id) {Swoole\Timer::clear($id);echo"⏰ Done\n";});Swoole\Timer::after(1000,function ()use ($id) {if (!Swoole\Timer::exists($id)) {echo"✅ All right!\n";    }});

The way of coroutine

go(function () {$i =0;while (true) {        Co::sleep(0.1);echo"📝 Do something...\n";if (++$i ===5) {echo"🛎 Done\n";break;        }    }echo"🎉 All right!\n";});

🔥 Amazing runtime hooks

Swoole\Runtime::enableCoroutine();$s =microtime(true);Co\run(function() {for ($c =100;$c--;) {go(function () {            ($redis =newRedis)->connect('127.0.0.1',6379);for ($n =100;$n--;) {assert($redis->get('awesome') ==='swoole');            }        });    }});echo'use' . (microtime(true) -$s) .' s';

How many things you can do in 1s?

Swoole\Runtime::enableCoroutine();$s =microtime(true);Co\run(function() {// i just want to sleep...for ($c =100;$c--;) {go(function () {for ($n =100;$n--;) {usleep(1000);            }        });    }// 10K file read and writefor ($c =100;$c--;) {go(function ()use ($c) {$tmp_filename ="/tmp/test-{$c}.php";for ($n =100;$n--;) {$self =file_get_contents(__FILE__);file_put_contents($tmp_filename,$self);assert(file_get_contents($tmp_filename) ===$self);            }unlink($tmp_filename);        });    }// 10K pdo and mysqli readfor ($c =50;$c--;) {go(function () {$pdo =newPDO('mysql:host=127.0.0.1;dbname=test;charset=utf8','root','root');$statement =$pdo->prepare('SELECT * FROM `user`');for ($n =100;$n--;) {$statement->execute();assert(count($statement->fetchAll()) >0);            }        });    }for ($c =50;$c--;) {go(function () {$mysqli =newMysqli('127.0.0.1','root','root','test');$statement =$mysqli->prepare('SELECT `id` FROM `user`');for ($n =100;$n--;) {$statement->bind_result($id);$statement->execute();$statement->fetch();assert($id >0);            }        });    }// php_stream tcp server & client with 12.8K requests in single processfunctiontcp_pack(string$data):string    {returnpack('n',strlen($data)) .$data;    }functiontcp_length(string$head):int    {returnunpack('n',$head)[1];    }go(function () {$ctx =stream_context_create(['socket' => ['so_reuseaddr' =>true,'backlog' =>128]]);$socket =stream_socket_server('tcp://0.0.0.0:9502',$errno,$errstr,STREAM_SERVER_BIND |STREAM_SERVER_LISTEN,$ctx        );if (!$socket) {echo"$errstr ($errno)\n";        }else {$i =0;while ($conn =stream_socket_accept($socket,1)) {stream_set_timeout($conn,5);for ($n =100;$n--;) {$data =fread($conn,tcp_length(fread($conn,2)));assert($data ==="Hello Swoole Server #{$n}!");fwrite($conn,tcp_pack("Hello Swoole Client #{$n}!"));                }if (++$i ===128) {fclose($socket);break;                }            }        }    });for ($c =128;$c--;) {go(function () {$fp =stream_socket_client("tcp://127.0.0.1:9502",$errno,$errstr,1);if (!$fp) {echo"$errstr ($errno)\n";            }else {stream_set_timeout($fp,5);for ($n =100;$n--;) {fwrite($fp,tcp_pack("Hello Swoole Server #{$n}!"));$data =fread($fp,tcp_length(fread($fp,2)));assert($data ==="Hello Swoole Client #{$n}!");                }fclose($fp);            }        });    }// udp server & client with 12.8K requests in single processgo(function () {$socket =newSwoole\Coroutine\Socket(AF_INET,SOCK_DGRAM,0);$socket->bind('127.0.0.1',9503);$client_map = [];for ($c =128;$c--;) {for ($n =0;$n <100;$n++) {$recv =$socket->recvfrom($peer);$client_uid ="{$peer['address']}:{$peer['port']}";$id =$client_map[$client_uid] = ($client_map[$client_uid] ?? -1) +1;assert($recv ==="Client: Hello #{$id}!");$socket->sendto($peer['address'],$peer['port'],"Server: Hello #{$id}!");            }        }$socket->close();    });for ($c =128;$c--;) {go(function () {$fp =stream_socket_client("udp://127.0.0.1:9503",$errno,$errstr,1);if (!$fp) {echo"$errstr ($errno)\n";            }else {for ($n =0;$n <100;$n++) {fwrite($fp,"Client: Hello #{$n}!");$recv =fread($fp,1024);list($address,$port) =explode(':', (stream_socket_get_name($fp,true)));assert($address ==='127.0.0.1' && (int)$port ===9503);assert($recv ==="Server: Hello #{$n}!");                }fclose($fp);            }        });    }});echo'use' . (microtime(true) -$s) .' s';

⌛️ Installation

Compiling requirements

1. Install via PECL (beginners)

pecl install swoole

2. Install from source (recommended)

git clone https://github.com/swoole/swoole-src.git&& \cd swoole-src

phpize&& \./configure&& \make&& make install

Enable extension in PHP

Extra compiler configurations

Upgrade

Major change since version 4.3.0

git clone https://github.com/swoole/ext-async.gitcd ext-asyncphpize./configuremake -j 4sudo make install

🍭 Benchmark

🔰️ Security issues

🖊️ Contribution

❤️ Contributors

🎙️ Official Evangelist

📃 License