The Swoole\Server class

(PHP 5 >= 5.2.0, PHP 7, PECL swoole >= 1.9.0)

Introduction

Class synopsis

Swoole\Server {

/* Methods */

public void addlistener ( string $host , integer $port , string $socket_type )

public boolean addProcess ( swoole_process $process )

public ReturnType after ( integer $after_time_ms , callable $callback [, string $param ] )

public boolean bind ( integer $fd , integer $uid )

public void clearTimer ( integer $timer_id )

void swoole_timer_clear ( integer $timer_id )

public boolean close ( integer $fd [, boolean $reset ] )

public boolean confirm ( integer $fd )

public array connection_info ( integer $fd [, integer $reactor_id ] )

public array connection_list ( integer $start_fd [, integer $pagesize ] )

public void defer ( callable $callback )

public void Swoole\Server\Port::__destruct ( void )

public ReturnType Swoole\Server\Port::on ( string $event_name , callable $callback )

public void Swoole\Server\Port::set ( array $settings )

public boolean exist ( integer $fd )

public void finish ( string $data )

public ReturnType getClientInfo ( integer $fd [, integer $reactor_id ] )

public array getClientList ( integer $start_fd [, integer $pagesize ] )

public integer getLastError ( void )

public mixed heartbeat ( boolean $if_close_connection )

public boolean listen ( string $host , integer $port , string $socket_type )

public void on ( string $event_name , callable $callback )

public void pause ( integer $fd )

public void protect ( integer $fd [, boolean $is_protected ] )

public boolean reload ( void )

public void resume ( integer $fd )

public boolean send ( integer $fd , string $data [, integer $reactor_id ] )

public boolean sendfile ( integer $fd , string $filename [, integer $offset ] )

public boolean sendMessage ( integer $worker_id , string $data )

public boolean sendto ( string $ip , integer $port , string $data [, string $server_socket ] )

public boolean sendwait ( integer $fd , string $data )

public ReturnType set ( array $settings )

public void shutdown ( void )

public void start ( void )

public array stats ( void )

public boolean stop ([ integer $worker_id ] )

public mixed task ( string $data [, integer $dst_worker_id [, callable $callback ]] )

public void taskwait ( string $data [, float $timeout [, integer $worker_id ]] )

public void taskWaitMulti ( array $tasks [, double $timeout_ms ] )

public void tick ( integer $interval_ms , callable $callback )

}

Swoole\Server::addlistener — Add a new listener to the server.
Swoole\Server::addProcess — Add a user defined swoole_process to the server.
Swoole\Server::after — Trigger a callback function after a period of time.
Swoole\Server::bind — Bind the connection to a user defined user ID.
Swoole\Server::clearTimer — Stop and destory a timer.
Swoole\Server::close — Close a connection to the client.
Swoole\Server::confirm — Check status of the connection.
Swoole\Server::connection_info — Get the connection info by file description.
Swoole\Server::connection_list — Get all of the established connections.
Swoole\Server::__construct — Construct a Swoole server.
Swoole\Server::defer — Delay execution of the callback function at the end of current EventLoop.
Swoole\Server\Port::__construct — Construct a server port
Swoole\Server\Port::__destruct — Destory server port
Swoole\Server\Port::on — Register callback functions by event.
Swoole\Server\Port::set — Set protocol of the server port.
Swoole\Server::exist — Check if the connection is existed.
Swoole\Server::finish — Used in task process for sending result to the worker process when the task is finished.
Swoole\Server::getClientInfo — Get the connection info by file description.
Swoole\Server::getClientList — Get all of the established connections.
Swoole\Server::getLastError — Get the error code of the most recent error.
Swoole\Server::heartbeat — Check all the connections on the server.
Swoole\Server::listen — Listen on the given IP and port, socket type.
Swoole\Server::on — Register a callback function by event name.
Swoole\Server::pause — Stop receiving data from the connection.
Swoole\Server::protect — Set the connection to be protected mode.
Swoole\Server::reload — Restart all the worker process.
Swoole\Server::resume — Start receving data from the connection.
Swoole\Server::send — Send data to the client.
Swoole\Server::sendfile — Send file to the connection.
Swoole\Server::sendMessage — Send message to worker processes by ID.
Swoole\Server::sendto — Send data to the remote UDP address.
Swoole\Server::sendwait — Send data to the remote socket in the blocking way.
Swoole\Server::set — Set the runtime settings of the swoole server.
Swoole\Server::shutdown — Shutdown the master server process, this function can be called in worker processes.
Swoole\Server::start — Start the Swoole server.
Swoole\Server::stats — Get the stats of the Swoole server.
Swoole\Server::stop — Stop the Swoole server.
Swoole\Server::task — Send data to the task worker processes.
Swoole\Server::taskwait — Send data to the task worker processes in blocking way.
Swoole\Server::taskWaitMulti — Execute multiple tasks concurrently.
Swoole\Server::tick — Repeats a given function at every given time-interval.

The Swoole\Server class

Introduction

Class synopsis

Table of Contents