Skip to content

Commit 181941f

Browse files
committed
Mark extensions deprecated and minor docs improvement
1 parent 81d17c1 commit 181941f

File tree

6 files changed

+37
-20
lines changed

6 files changed

+37
-20
lines changed

README.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ single [`run()`](#run) call that is controlled by the user.
2121
* [Loop implementations](#loop-implementations)
2222
* [StreamSelectLoop](#streamselectloop)
2323
* [ExtEventLoop](#exteventloop)
24-
* [ExtLibeventLoop](#extlibeventloop)
25-
* [ExtLibevLoop](#extlibevloop)
24+
* [~~ExtLibeventLoop~~](#extlibeventloop)
25+
* [~~ExtLibevLoop~~](#extlibevloop)
2626
* [ExtEvLoop](#extevloop)
2727
* [ExtUvLoop](#extuvloop)
2828
* [LoopInterface](#loopinterface)
@@ -362,34 +362,41 @@ See also [`addTimer()`](#addtimer) for more details.
362362

363363
An `ext-event` based event loop.
364364

365-
This uses the [`event` PECL extension](https://pecl.php.net/package/event).
366-
It supports the same backends as libevent.
365+
This uses the [`event` PECL extension](https://pecl.php.net/package/event),
366+
that provides an interface to `libevent` library.
367+
`libevent` itself supports a number of system-specific backends (epoll, kqueue).
367368

368369
This loop is known to work with PHP 5.4 through PHP 7+.
369370

370371
#### ExtEvLoop
371372

372373
An `ext-ev` based event loop.
373374

374-
This loop uses the [`ev` PECL extension](https://pecl.php.net/package/ev), that
375-
provides an interface to `libev` library.
375+
This loop uses the [`ev` PECL extension](https://pecl.php.net/package/ev),
376+
that provides an interface to `libev` library.
377+
`libev` itself supports a number of system-specific backends (epoll, kqueue).
378+
376379

377380
This loop is known to work with PHP 5.4 through PHP 7+.
378381

379382
#### ExtUvLoop
380383

381384
An `ext-uv` based event loop.
382385

383-
This loop uses the [`uv` PECL extension](https://pecl.php.net/package/uv), that
384-
provides an interface to `libuv` library.
386+
This loop uses the [`uv` PECL extension](https://pecl.php.net/package/uv),
387+
that provides an interface to `libuv` library.
388+
`libuv` itself supports a number of system-specific backends (epoll, kqueue).
385389

386390
This loop is known to work with PHP 7+.
387391

388-
#### ExtLibeventLoop
392+
#### ~~ExtLibeventLoop~~
393+
394+
> Deprecated since v1.2.0, use [`ExtEventLoop`](#exteventloop) instead.
389395
390396
An `ext-libevent` based event loop.
391397

392-
This uses the [`libevent` PECL extension](https://pecl.php.net/package/libevent).
398+
This uses the [`libevent` PECL extension](https://pecl.php.net/package/libevent),
399+
that provides an interface to `libevent` library.
393400
`libevent` itself supports a number of system-specific backends (epoll, kqueue).
394401

395402
This event loop does only work with PHP 5.
@@ -408,12 +415,15 @@ As such, it's recommended to use `stream_set_read_buffer($stream, 0);`
408415
to disable PHP's internal read buffer in this case.
409416
See also [`addReadStream()`](#addreadstream) for more details.
410417

411-
#### ExtLibevLoop
418+
#### ~~ExtLibevLoop~~
419+
420+
> Deprecated since v1.2.0, use [`ExtEvLoop`](#extevloop) instead.
412421
413422
An `ext-libev` based event loop.
414423

415-
This uses an [unofficial `libev` extension](https://github.com/m4rw3r/php-libev).
416-
It supports the same backends as libevent.
424+
This uses an [unofficial `libev` extension](https://github.com/m4rw3r/php-libev),
425+
that provides an interface to `libev` library.
426+
`libev` itself supports a number of system-specific backends (epoll, kqueue).
417427

418428
This loop does only work with PHP 5.
419429
An update for PHP 7 is [unlikely](https://github.com/m4rw3r/php-libev/issues/8)

src/ExtEvLoop.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
*
1515
* This loop uses the [`ev` PECL extension](https://pecl.php.net/package/ev),
1616
* that provides an interface to `libev` library.
17+
* `libev` itself supports a number of system-specific backends (epoll, kqueue).
1718
*
1819
* This loop is known to work with PHP 5.4 through PHP 7+.
1920
*

src/ExtEventLoop.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@
1212
/**
1313
* An `ext-event` based event loop.
1414
*
15-
* This uses the [`event` PECL extension](https://pecl.php.net/package/event).
16-
* It supports the same backends as libevent.
15+
* This uses the [`event` PECL extension](https://pecl.php.net/package/event),
16+
* that provides an interface to `libevent` library.
17+
* `libevent` itself supports a number of system-specific backends (epoll, kqueue).
1718
*
1819
* This loop is known to work with PHP 5.4 through PHP 7+.
1920
*

src/ExtLibevLoop.php

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,19 @@
1212
use SplObjectStorage;
1313

1414
/**
15-
* An `ext-libev` based event loop.
15+
* [Deprecated] An `ext-libev` based event loop.
1616
*
17-
* This uses an [unofficial `libev` extension](https://github.com/m4rw3r/php-libev).
18-
* It supports the same backends as libevent.
17+
* This uses an [unofficial `libev` extension](https://github.com/m4rw3r/php-libev),
18+
* that provides an interface to `libev` library.
19+
* `libev` itself supports a number of system-specific backends (epoll, kqueue).
1920
*
2021
* This loop does only work with PHP 5.
2122
* An update for PHP 7 is [unlikely](https://github.com/m4rw3r/php-libev/issues/8)
2223
* to happen any time soon.
2324
*
2425
* @see https://github.com/m4rw3r/php-libev
2526
* @see https://gist.github.com/1688204
27+
* @deprecated 1.2.0, use [`ExtEvLoop`](#extevloop) instead.
2628
*/
2729
final class ExtLibevLoop implements LoopInterface
2830
{

src/ExtLibeventLoop.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@
1010
use SplObjectStorage;
1111

1212
/**
13-
* An `ext-libevent` based event loop.
13+
* [Deprecated] An `ext-libevent` based event loop.
1414
*
15-
* This uses the [`libevent` PECL extension](https://pecl.php.net/package/libevent).
15+
* This uses the [`libevent` PECL extension](https://pecl.php.net/package/libevent),
16+
* that provides an interface to `libevent` library.
1617
* `libevent` itself supports a number of system-specific backends (epoll, kqueue).
1718
*
1819
* This event loop does only work with PHP 5.
@@ -32,6 +33,7 @@
3233
* See also [`addReadStream()`](#addreadstream) for more details.
3334
*
3435
* @link https://pecl.php.net/package/libevent
36+
* @deprecated 1.2.0, use [`ExtEventLoop`](#exteventloop) instead.
3537
*/
3638
final class ExtLibeventLoop implements LoopInterface
3739
{

src/ExtUvLoop.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
*
1212
* This loop uses the [`uv` PECL extension](https://pecl.php.net/package/uv),
1313
* that provides an interface to `libuv` library.
14+
* `libuv` itself supports a number of system-specific backends (epoll, kqueue).
1415
*
1516
* This loop is known to work with PHP 7+.
1617
*

0 commit comments

Comments
 (0)