Skip to content

Commit e86e8a0

Browse files
committed
Improve documentation
1 parent ba697a2 commit e86e8a0

2 files changed

Lines changed: 5 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,11 @@ for the required multicast socket options and constants.
4141

4242
These options are only available to the low level socket API (ext-sockets), not
4343
to the newer stream based networking API.
44-
Because of this, this library depends on sockets based on `ext-sockets`, provided
45-
via [clue/socket-react](https://github.com/clue/php-socket-react)
46-
and [clue/socket-raw](https://github.com/clue/php-socket-raw).
47-
4844
For the most part, React PHP is built around the general purpose stream based API
4945
and has only somewhat limited support for the low level socket API.
50-
The package [clue/socket-react](https://github.com/clue/php-socket-react)
51-
works around this for the most part.
52-
Simply put, you should try to avoid using the default `StreamSelectLoop`,
53-
as it requires a workaround to poll the socket resources via a periodic timer
54-
every 10ms.
46+
Because of this, this library uses a workaround to create stream based sockets
47+
and then sets the required socket options on its underlying low level socket
48+
resource.
5549

5650
This library also provides somewhat limited support for PHP 5.3.
5751
While this version lacks the required socket options and constants for listening

composer.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
"clue/hexdump": "0.2.*"
2323
},
2424
"suggest": {
25-
"php": "PHP 5.4+ is required for listening on multicast addresses and IGMP announcements"
25+
"php": "PHP 5.4+ is required for listening on multicast addresses (socket options to send IGMP announcements)",
26+
"ext-sockets": "Low level socket API required for listening on multicast addresses (socket options to send IGMP announcements)"
2627
}
2728
}

0 commit comments

Comments
 (0)