From ce5ebe1e9c5199ff4ee3e0c1fc9b856ab8a2effc Mon Sep 17 00:00:00 2001 From: David Buchmann Date: Wed, 20 Oct 2021 08:14:52 +0200 Subject: [PATCH] fix references to the deprecated factory the readme should not recommend to use the factory anymore but Loop::create Co-authored-by: Simon Frings --- README.md | 11 ++++++----- src/ExtLibeventLoop.php | 4 ++-- src/StreamSelectLoop.php | 5 +++-- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b89ad575..e1ccdb29 100644 --- a/README.md +++ b/README.md @@ -339,7 +339,7 @@ All of the event loops support these features: For most consumers of this package, the underlying event loop implementation is an implementation detail. -You should use the [`Factory`](#factory) to automatically create a new instance. +You should use the [`Loop` class](#loop) to automatically create a new instance. Advanced! If you explicitly need a certain event loop implementation, you can manually instantiate one of the following classes. @@ -356,8 +356,9 @@ function and is the only implementation which works out of the box with PHP. This event loop works out of the box on PHP 5.3 through PHP 7+ and HHVM. This means that no installation is required and this library works on all platforms and supported PHP versions. -Accordingly, the [`Factory`](#factory) will use this event loop by default if -you do not install any of the event loop extensions listed below. +Accordingly, the [`Loop` class](#loop) and the deprecated [`Factory`](#factory) +will use this event loop by default if you do not install any of the event loop +extensions listed below. Under the hood, it does a simple `select` system call. This system call is limited to the maximum file descriptor number of @@ -433,8 +434,8 @@ This event loop does only work with PHP 5. An [unofficial update](https://github.com/php/pecl-event-libevent/pull/2) for PHP 7 does exist, but it is known to cause regular crashes due to `SEGFAULT`s. To reiterate: Using this event loop on PHP 7 is not recommended. -Accordingly, the [`Factory`](#factory) will not try to use this event loop on -PHP 7. +Accordingly, neither the [`Loop` object](#loop) nor the deprecated +[`Factory`](#factory) will try to use this event loop on PHP 7. This event loop is known to trigger a readable listener only if the stream *becomes* readable (edge-triggered) and may not trigger if the diff --git a/src/ExtLibeventLoop.php b/src/ExtLibeventLoop.php index 2ea7ffa5..d5699d8f 100644 --- a/src/ExtLibeventLoop.php +++ b/src/ExtLibeventLoop.php @@ -20,8 +20,8 @@ * An [unofficial update](https://github.com/php/pecl-event-libevent/pull/2) for * PHP 7 does exist, but it is known to cause regular crashes due to `SEGFAULT`s. * To reiterate: Using this event loop on PHP 7 is not recommended. - * Accordingly, the [`Factory`](#factory) will not try to use this event loop on - * PHP 7. + * Accordingly, neither the [`Loop` object](#loop) nor the deprecated + * [`Factory`](#factory) will try to use this event loop on PHP 7. * * This event loop is known to trigger a readable listener only if * the stream *becomes* readable (edge-triggered) and may not trigger if the diff --git a/src/StreamSelectLoop.php b/src/StreamSelectLoop.php index b89d8000..db3f7706 100644 --- a/src/StreamSelectLoop.php +++ b/src/StreamSelectLoop.php @@ -15,8 +15,9 @@ * This event loop works out of the box on PHP 5.4 through PHP 7+ and HHVM. * This means that no installation is required and this library works on all * platforms and supported PHP versions. - * Accordingly, the [`Factory`](#factory) will use this event loop by default if - * you do not install any of the event loop extensions listed below. + * Accordingly, the [`Loop` class](#loop) and the deprecated [`Factory`](#factory) + * will use this event loop by default if you do not install any of the event loop + * extensions listed below. * * Under the hood, it does a simple `select` system call. * This system call is limited to the maximum file descriptor number of