Swoole server
Swoole server
Swoole server provides the API for developers to write TCP, UDP, Unix Socket asynchronous servers. It supports IPv4, IPv6, one Way, two Way SSL and TLS Encryption. Developers do not have to know the internal implementations, only have to write the logics of the server in the callback functions.
Swoole server apis only can be used in the php cli mode.
-
- swoole_server::__construct
- swoole_server->set(array $setting)
- swoole_server->on(string $event, mixed $callback)
- swoole_server->addListener(string $host, int $port, $type = SWOOLE_SOCK_TCP)
- swoole_server->listen(string $host, int $port, $type = SWOOLE_SOCK_TCP)
- swoole_server->addProcess(swoole_process $process)
- swoole_server->start()
- swoole_server->reload(bool $only_reload_taskworkrer = false)
- swoole_server->stop($worker_id)
- swoole_server->shutdown()
- swoole_server->tick(int $intval_ms, mixed $callback_function)
- swoole_server->after(int $after_time_ms, mixed $callback_function)
- swoole_server->defer(callable $callback)
- swoole_server->clearTimer(int $timer_id)
- swoole_server->close(int $fd, bool $reset = false)
- swoole_server->send(int $fd, string $data, int $reactorThreadId = 0)
- swoole_server->sendfile(int $fd, string $filename, int $offset =0, int $length = 0)
- swoole_server->sendto(string $ip, int $port, string $data, int $server_socket = -1)
- swoole_server->sendwait(int $fd, string $send_data)
- swoole_server->sendMessage(string $message, int $dst_worker_id)
- swoole_server->exist(int $fd)
- swoole_server->pause(int $fd)
- swoole_server->resume(int $fd)
- swoole_server->connection_info(int $fd, int $from_id, bool $ignore_close = false)
- swoole_server->connection_list(int $start_fd = 0, int $pagesize = 10)
- swoole_server->bind(int $fd, int $uid)
- swoole_server->stats()
- swoole_server->task(mixed $data, int $dst_worker_id = -1)
- swoole_server->taskwait(mixed $task_data, float $timeout = 0.5, int $dst_worker_id = -1)
- swoole_server->taskWaitMulti(array $tasks, double $timeout)
- swoole_server->finish(string $data)
- swoole_server->heartbeat(bool $if_close_connection = true)
- swoole_server->getLastError()
- swoole_server->getSocket()
- swoole_server->protect(int $fd, bool $value = true)
QuickStart
Initialize the server
<?php
$server = new swoole_server("127.0.0.1", 9501, SWOOLE_BASE, SWOOLE_SOCK_TCP);
Set runtime paramaters
<?php
$server->set(array(
'worker_num' => 4, // The number of worker processes
'daemonize' => true, // Whether start as a daemon process
'backlog' => 128, // TCP backlog connection number
));
Register callback functions
<?php
$server->on('Connect', 'my_onConnect');
$server->on('Receive', 'my_onReceive');
$server->on('Close', 'my_onClose');
There are four types of callback functions
Start the server
<?php
$server->start();
Get the server attributes
<?php
$server->manager_pid; // PID of manager process, send SIGUSR1 to this process to reload the application
$server->master_pid; // PID of master process, send SIGTERM signal to this process to shutdown the server
$server->connections; // The connections established
