clue/multicast-react 
Multicast UDP messages, built on top of React PHP.
Multicast UDP messages are needed for quite a few (low-level) networking protocols. This library exposes a simple subset of commonly needed functionality for multicast networking through an easy to use API.
Among others, multicast networking is the basis for:
- MDNS (Multicast DNS)
- HTTPU/HTTPMU (Multicast and Unicast UDP HTTP Messages)
- UPNP/SSDP (Univeral Plug and Play / Simple Service Discovery Protocol).
Table of Contents
Quickstart example
Once installed, you can use the following code to create a simple echo server that listens for incoming multicast messages:
$loop = React\EventLoop\Factory::create();
$factory = new Factory($loop);
$socket = $factory->createReceiver('224.10.20.30:4050');
$socket->on('message', function ($data, $remote) use ($socket) {
echo 'Sending back ' . strlen($data) . ' bytes to ' . $remote . PHP_EOL;
$socket->send($data, $remote);
});
$loop->run();See also the examples.
Usage
Factory
The Factory is responsible for creating your Socket instances.
It also registers everything with the main EventLoop.
$loop = React\EventLoop\Factory::create();
$factory = new Factory($loop);createSender()
The createSender() method can be used to create a socket capable of sending outgoing multicast datagrams and receiving incoming unicast responses. It returns a Socket instance.
$socket = $factory->createSender();
// send a multicast message to everybody listening on the given address
$socket->send('hello?', '224.10.20.30:4050');
// report incoming unicast replies
$socket->on('message', function ($data, $address) {
echo 'received ' . strlen($data) . ' bytes from ' . $address . PHP_EOL;
});This method works on PHP versions as old as PHP 5.3 (and up), as its socket API has always been level 1 multicast conformant.
createReceiver()
The createReceiver($address) method can be used to create a socket capable of receiving incoming multicast datagrams and sending outgoing unicast or multicast datagrams. It returns a Socket instance.
$socket = $factory->createReceiver('224.10.20.30:4050');
// report incoming multicast messages
$socket->on('message', function ($data, $remote) use ($socket) {
echo 'Sending back ' . strlen($data) . ' bytes to ' . $remote . PHP_EOL;
// send a unicast reply to the remote
$socket->send($data, $remote);
});This method requires PHP 5.4 (or up) and ext-sockets.
Otherwise, it will throw a BadMethodCallException.
This is a requirement because receiving multicast datagrams requires a
level 2 multicast conformant
socket API.
The required multicast socket options and constants have been added with
PHP 5.4 (and up).
These options are only available to the low level socket API (ext-sockets), not
to the newer stream based networking API.
Internally, this library uses a workaround to create stream based sockets and then sets the required socket options on its underlying low level socket resource. This is done because React PHP is built around the general purpose stream based API and has only somewhat limited support for the low level socket API.
Socket
The Factory creates instances of the React\Datagram\Socket class from the react/datagram package.
$socket->send($message, $address);
$socket->on('message', function ($message, $address) { });
$socket->on('close', function() { });
$socket->pause();
$socket->resume();
$socket->end();
$socket->close();Please refer to the datagram documentation for more details.
Install
The recommended way to install this library is through Composer. New to Composer?
$ composer require clue/multicast-react:~1.0License
MIT