11# clue/reactphp-multicast
22
3- [ ![ CI status] ( https://github.com/clue/reactphp-multicast/workflows/CI /badge.svg )] ( https://github.com/clue/reactphp-multicast/actions )
3+ [ ![ CI status] ( https://github.com/clue/reactphp-multicast/actions/ workflows/ci.yml /badge.svg )] ( https://github.com/clue/reactphp-multicast/actions )
44[ ![ installs on Packagist] ( https://img.shields.io/packagist/dt/clue/multicast-react?color=blue&label=installs%20on%20Packagist )] ( https://packagist.org/packages/clue/multicast-react )
55
66Simple, event-driven multicast UDP message client and server for [ ReactPHP] ( https://reactphp.org/ ) .
@@ -41,6 +41,10 @@ Once [installed](#install), you can use the following code to create a simple
4141echo server that listens for incoming multicast messages:
4242
4343``` php
44+ <?php
45+
46+ require __DIR__ . '/vendor/autoload.php';
47+
4448$factory = new Clue\React\Multicast\Factory();
4549$socket = $factory->createReceiver('224.10.20.30:4050');
4650
@@ -51,7 +55,7 @@ $socket->on('message', function ($data, $remote) use ($socket) {
5155
5256```
5357
54- See also the [ examples] ( examples ) .
58+ See also the [ examples] ( examples/ ) .
5559
5660## Usage
5761
@@ -114,7 +118,7 @@ This is a requirement because receiving multicast datagrams requires a
114118[ level 2 multicast conformant] ( https://www.tldp.org/HOWTO/Multicast-HOWTO-2.html#ss2.2 )
115119socket API.
116120The required multicast socket options and constants have been added with
117- [ PHP 5.4] ( http ://php.net /manual/en/migration54.global-constants.php ) (and up).
121+ [ PHP 5.4] ( https ://php-legacy-docs.zend.com /manual/php5/ en/migration54.new-features ) (and up).
118122These options are only available to the low level socket API (ext-sockets), not
119123to the newer stream based networking API.
120124
@@ -147,22 +151,22 @@ Please refer to the [datagram documentation](https://github.com/reactphp/datagra
147151
148152## Install
149153
150- The recommended way to install this library is [ through Composer] ( https://getcomposer.org ) .
154+ The recommended way to install this library is [ through Composer] ( https://getcomposer.org/ ) .
151155[ New to Composer?] ( https://getcomposer.org/doc/00-intro.md )
152156
153157This project follows [ SemVer] ( https://semver.org/ ) .
154158This will install the latest supported version:
155159
156160``` bash
157- $ composer require clue/multicast-react:^1.1
161+ composer require clue/multicast-react:^1.1
158162```
159163
160164See also the [ CHANGELOG] ( CHANGELOG.md ) for details about version upgrades.
161165
162166This project aims to run on any platform and thus does not require any PHP
163167extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
164168HHVM.
165- It's * highly recommended to use PHP 7+ * for this project.
169+ It's * highly recommended to use the latest supported PHP version * for this project.
166170
167171The [ ` createSender() ` ] ( #createsender ) method works on all supported platforms
168172without any additional requirements. However, the [ ` createReceiver() ` ] ( #createreceiver )
@@ -171,16 +175,16 @@ method requires PHP 5.4 (or up) and `ext-sockets`. See above for more details.
171175## Tests
172176
173177To run the test suite, you first need to clone this repo and then install all
174- dependencies [ through Composer] ( https://getcomposer.org ) :
178+ dependencies [ through Composer] ( https://getcomposer.org/ ) :
175179
176180``` bash
177- $ composer install
181+ composer install
178182```
179183
180184To run the test suite, go to the project root and run:
181185
182186``` bash
183- $ php vendor/bin/phpunit
187+ php vendor/bin/phpunit
184188```
185189
186190## License
0 commit comments