Skip to content

Instantly share code, notes, and snippets.

@navarr
Last active June 7, 2022 00:38
Show Gist options
  • Save navarr/459321 to your computer and use it in GitHub Desktop.
Save navarr/459321 to your computer and use it in GitHub Desktop.
<?php
/*! @class SocketServer
@author Navarr Barnier
@abstract A Framework for creating a multi-client server using the PHP language.
*/
class SocketServer
{
/*! @var config
@abstract Array - an array of configuration information used by the server.
*/
protected $config;
/*! @var hooks
@abstract Array - a dictionary of hooks and the callbacks attached to them.
*/
protected $hooks;
/*! @var master_socket
@abstract resource - The master socket used by the server.
*/
protected $master_socket;
/*! @var max_clients
@abstract unsigned int - The maximum number of clients allowed to connect.
*/
public $max_clients = 10;
/*! @var max_read
@abstract unsigned int - The maximum number of bytes to read from a socket at a single time.
*/
public $max_read = 1024;
/*! @var clients
@abstract Array - an array of connected clients.
*/
public $clients;
/*! @function __construct
@abstract Creates the socket and starts listening to it.
@param string - IP Address to bind to, NULL for default.
@param int - Port to bind to
@result void
*/
public function __construct($bind_ip,$port)
{
set_time_limit(0);
$this->hooks = array();
$this->config["ip"] = $bind_ip;
$this->config["port"] = $port;
$this->master_socket = socket_create(AF_INET, SOCK_STREAM, 0);
socket_bind($this->master_socket,$this->config["ip"],$this->config["port"]) or die("Issue Binding");
socket_getsockname($this->master_socket,$bind_ip,$port);
socket_listen($this->master_socket);
SocketServer::debug("Listenting for connections on {$bind_ip}:{$port}");
}
/*! @function hook
@abstract Adds a function to be called whenever a certain action happens. Can be extended in your implementation.
@param string - Command
@param callback- Function to Call.
@see unhook
@see trigger_hooks
@result void
*/
public function hook($command,$function)
{
$command = strtoupper($command);
if(!isset($this->hooks[$command])) { $this->hooks[$command] = array(); }
$k = array_search($function,$this->hooks[$command]);
if($k === FALSE)
{
$this->hooks[$command][] = $function;
}
}
/*! @function unhook
@abstract Deletes a function from the call list for a certain action. Can be extended in your implementation.
@param string - Command
@param callback- Function to Delete from Call List
@see hook
@see trigger_hooks
@result void
*/
public function unhook($command = NULL,$function)
{
$command = strtoupper($command);
if($command !== NULL)
{
$k = array_search($function,$this->hooks[$command]);
if($k !== FALSE)
{
unset($this->hooks[$command][$k]);
}
} else {
$k = array_search($this->user_funcs,$function);
if($k !== FALSE)
{
unset($this->user_funcs[$k]);
}
}
}
/*! @function loop_once
@abstract Runs the class's actions once.
@discussion Should only be used if you want to run additional checks during server operation. Otherwise, use infinite_loop()
@param void
@see infinite_loop
@result bool - True
*/
public function loop_once()
{
// Setup Clients Listen Socket For Reading
$read[0] = $this->master_socket;
for($i = 0; $i < $this->max_clients; $i++)
{
if(isset($this->clients[$i]))
{
$read[$i + 1] = $this->clients[$i]->socket;
}
}
// Set up a blocking call to socket_select
if(socket_select($read,$write = NULL, $except = NULL, $tv_sec = 5) < 1)
{
// SocketServer::debug("Problem blocking socket_select?");
return true;
}
// Handle new Connections
if(in_array($this->master_socket, $read))
{
for($i = 0; $i < $this->max_clients; $i++)
{
if(empty($this->clients[$i]))
{
$temp_sock = $this->master_socket;
$this->clients[$i] = new SocketServerClient($this->master_socket,$i);
$this->trigger_hooks("CONNECT",$this->clients[$i],"");
break;
}
elseif($i == ($this->max_clients-1))
{
SocketServer::debug("Too many clients... :( ");
}
}
}
// Handle Input
for($i = 0; $i < $this->max_clients; $i++) // for each client
{
if(isset($this->clients[$i]))
{
if(in_array($this->clients[$i]->socket, $read))
{
$input = socket_read($this->clients[$i]->socket, $this->max_read);
if($input == null)
{
$this->disconnect($i);
}
else
{
SocketServer::debug("{$i}@{$this->clients[$i]->ip} --> {$input}");
$this->trigger_hooks("INPUT",$this->clients[$i],$input);
}
}
}
}
return true;
}
/*! @function disconnect
@abstract Disconnects a client from the server.
@param int - Index of the client to disconnect.
@param string - Message to send to the hooks
@result void
*/
public function disconnect($client_index,$message = "")
{
$i = $client_index;
SocketServer::debug("Client {$i} from {$this->clients[$i]->ip} Disconnecting");
$this->trigger_hooks("DISCONNECT",$this->clients[$i],$message);
$this->clients[$i]->destroy();
unset($this->clients[$i]);
}
/*! @function trigger_hooks
@abstract Triggers Hooks for a certain command.
@param string - Command who's hooks you want to trigger.
@param object - The client who activated this command.
@param string - The input from the client, or a message to be sent to the hooks.
@result void
*/
public function trigger_hooks($command,&$client,$input)
{
if(isset($this->hooks[$command]))
{
foreach($this->hooks[$command] as $function)
{
SocketServer::debug("Triggering Hook '{$function}' for '{$command}'");
$continue = call_user_func($function,&$this,&$client,$input);
if($continue === FALSE) { break; }
}
}
}
/*! @function infinite_loop
@abstract Runs the server code until the server is shut down.
@see loop_once
@param void
@result void
*/
public function infinite_loop()
{
$test = true;
do
{
$test = $this->loop_once();
}
while($test);
}
/*! @function debug
@static
@abstract Outputs Text directly.
@discussion Yeah, should probably make a way to turn this off.
@param string - Text to Output
@result void
*/
public static function debug($text)
{
echo("{$text}\r\n");
}
/*! @function socket_write_smart
@static
@abstract Writes data to the socket, including the length of the data, and ends it with a CRLF unless specified.
@discussion It is perfectly valid for socket_write_smart to return zero which means no bytes have been written. Be sure to use the === operator to check for FALSE in case of an error.
@param resource- Socket Instance
@param string - Data to write to the socket.
@param string - Data to end the line with. Specify a "" if you don't want a line end sent.
@result mixed - Returns the number of bytes successfully written to the socket or FALSE on failure. The error code can be retrieved with socket_last_error(). This code may be passed to socket_strerror() to get a textual explanation of the error.
*/
public static function socket_write_smart(&$sock,$string,$crlf = "\r\n")
{
SocketServer::debug("<-- {$string}");
if($crlf) { $string = "{$string}{$crlf}"; }
return socket_write($sock,$string,strlen($string));
}
/*! @function __get
@abstract Magic Method used for allowing the reading of protected variables.
@discussion You never need to use this method, simply calling $server->variable works because of this method's existence.
@param string - Variable to retrieve
@result mixed - Returns the reference to the variable called.
*/
function &__get($name)
{
return $this->{$name};
}
}
/*! @class SocketServerClient
@author Navarr Barnier
@abstract A Client Instance for use with SocketServer
*/
class SocketServerClient
{
/*! @var socket
@abstract resource - The client's socket resource, for sending and receiving data with.
*/
protected $socket;
/*! @var ip
@abstract string - The client's IP address, as seen by the server.
*/
protected $ip;
/*! @var hostname
@abstract string - The client's hostname, as seen by the server.
@discussion This variable is only set after calling lookup_hostname, as hostname lookups can take up a decent amount of time.
@see lookup_hostname
*/
protected $hostname;
/*! @var server_clients_index
@abstract int - The index of this client in the SocketServer's client array.
*/
protected $server_clients_index;
/*! @function __construct
@param resource- The resource of the socket the client is connecting by, generally the master socket.
@param int - The Index in the Server's client array.
@result void
*/
public function __construct(&$socket,$i)
{
$this->server_clients_index = $i;
$this->socket = socket_accept($socket) or die("Failed to Accept");
SocketServer::debug("New Client Connected");
socket_getpeername($this->socket,$ip);
$this->ip = $ip;
}
/*! @function lookup_hostname
@abstract Searches for the user's hostname and stores the result to hostname.
@see hostname
@param void
@result string - The hostname on success or the IP address on failure.
*/
public function lookup_hostname()
{
$this->hostname = gethostbyaddr($this->ip);
return $this->hostname;
}
/*! @function destroy
@abstract Closes the socket. Thats pretty much it.
@param void
@result void
*/
public function destroy()
{
socket_close($this->socket);
}
function &__get($name)
{
return $this->{$name};
}
function __isset($name)
{
return isset($this->{$name});
}
}
@navarr
Copy link
Author

navarr commented Jun 30, 2010

Usage:

$server = new SocketServer(null,9001); // Binds to determined IP
$server->hook("connect","connect_function"); // On connect does connect_function($server,$client,"");
$server->hook("disconnect","disconnect_function"); // On disconnect does disconnect_function($server,$client,"");
$server->hook("input","handle_input"); // When receiving input does handle_input($server,$client,$input);
$server->infinite_loop(); // starts the loop.

@oacApps
Copy link

oacApps commented May 6, 2015

hi,
Looks like this is what I am looking for... Can you please help me with when I am trying to use your class .. getting error:
Fatal error: Call-time pass-by-reference has been removed in SocketServer.class.php on line 203

@LBanfalvi
Copy link

hi,
I found your code very useful! Is there a way to force close/disconnect the connection in the handle_input method? Thanks for your help!

@justradojko
Copy link

Seems that this class is not working with PHP version grater then 5.4

@michiel75
Copy link

@oacApps, same issue here, do you already have a solution for that?

@michiel75
Copy link

hoi perfect code, I only have an issue to get it to work, when I use the latest version with the &, tehn I get the error: Fatal error: Call-time pass-by-reference has been removed in SocketServer.class.php on line 203, when I remove the & at $this and at $client, I get the following error: Parameter 1 to handle_input() expected to be a reference, value given in

@86bjorn
Copy link

86bjorn commented Jan 4, 2016

Im also trying to get it to work but the handle function isnt executed

@kayabe
Copy link

kayabe commented Apr 5, 2016

Replace:
$continue = call_user_func($function,&$this,&$client,$input);
With:
$continue = call_user_func_array($function, array(&$this,&$client,$input));

@GrandmaTi
Copy link

Hi there,

found this source by stackoverflow and it looks really good for my multiple UDP connection.
I try the code on my localhost (xampp) like this:
$server = new SocketServer("127.0.0.1", 9999);
$server->infinite_loop();

On clientside I start the connection as followed:
$server = '127.0.0.1';
$port = 9999;
if(!($sock = socket_create(AF_INET, SOCK_DGRAM, 0))) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo "Couldn't create socket: [$errorcode] $errormsg<br>";
} else {
socket_sendto($sock, $msg , strlen($msg) , 0 , $server , $port);
}
The server detects the connection but then a warning occurs:
PHP: Warning: socket_accept(): unable to accept incoming connection [10045]: ...object type not supported
The warning is caused by socket_accept in the SocketServerClient constructor.

Has someone an Idea?

@FXUDarkNova
Copy link

When using this class I get this error Parse error: syntax error, unexpected '$server' (T_VARIABLE) in /Applications/XAMPP/xamppfiles/htdocs/socketserver/test.php on line 3 any ideas?

@aliqasemzadeh
Copy link

hello,
I get:
Too many open files in /root/serverg/SocketServer.class.php on line 279 Failed to Accept
How can I fix this issue?

@DenniesChang
Copy link

I would like to create 2 socket servers in single PHP program, one bind port 80, and the other bind port 8888 for control usage.

But when I invoke $server->infinite_loop(), the code gets into infinite loop, and the $server2->infinite_loop() seems not be called, what should I do to make the $server2 works?

@nalkat
Copy link

nalkat commented Jul 3, 2018

This does not handle concurrent connections. This has been a recurring theme for all of the attempts that I have seen so far.

While it is true that multiple people can connect simultaneously, any commands will block until the previous command finishes. You can see that by creating the following test script:

socket,"Welcome, you connected" . PHP_EOL); return true; } function handle_input($server, $client, $what) { socket_write($client->socket,"I am going to block for a while to see if others can still do things" . PHP_EOL); sleep(20); } $server = new SocketServer("172.16.69.158",9001); // Binds to determined IP $server->hook("connect","connect_function"); // On connect does connect_function($server,$client,""); $server->hook("disconnect","disconnect_function"); // On disconnect does disconnect_function($server,$client,""); $server->hook("input","handle_input"); // When receiving input does handle_input($server,$client,$input); $server->infinite_loop(); // starts the loop. ?>

[user@host1]:# php test.php
on another host/terminal, use telnet to connect, write something in the window, open another host/terminal and do the same. You will see that this is not really a multi-user implementation at all. You can get the same results with:

While I have yet to figure out a workaround, it will assuredly will have something to do with forking client processes (which doesn't seem to work so well).

I do like how the author created the function hooks though. That is a really nice "feature". This could potentially be a useful base class for handling client connectivity if the limitation of socket_select|stream_select could be overcome.

Overall, nice job, but it doesn't do what the author claims it does.

If anyone has come up with a solution to this issue, please post it.

@navarr
Copy link
Author

navarr commented Jul 3, 2018

@nalkat I would say it's still multi-user, but of course a process (and a processor) can only do one thing at a time. That is just how it is. Forking would help here.

You should check out https://reactphp.org/ for non-blocking IO. It is likely closer to what you want.

It has the same problem, however it has features to work around it

@RomanStone
Copy link

RomanStone commented Apr 25, 2019

Checkout my example, in plain php (no oop) demonstration how socket_select() can handle multiple connections without block
https://gist.github.com/RomanStone/8ec2472d2c90440ea1c11cda2581d058

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment