Skip to content

Commit 0426973

Browse files
committed
Improve documentation and examples
1 parent bc01ce1 commit 0426973

File tree

4 files changed

+11
-6
lines changed

4 files changed

+11
-6
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ built on top of [ReactPHP](https://reactphp.org/).
1010
Let's say you crawl a page and find that you need to send 100 HTTP requests to
1111
following pages which each takes `0.2s`. You can either send them all
1212
sequentially (taking around `20s`) or you can use
13-
[ReactPHP](https://reactphp.org) to concurrently request all your pages at the
13+
[ReactPHP](https://reactphp.org/) to concurrently request all your pages at the
1414
same time. This works perfectly fine for a small number of operations, but
1515
sending an excessive number of requests can either take up all resources on your
1616
side or may get you banned by the remote side as it sees an unreasonable number
@@ -84,12 +84,14 @@ $q = new Clue\React\Mq\Queue(3, null, function ($url) use ($browser) {
8484
foreach ($urls as $url) {
8585
$q($url)->then(function (Psr\Http\Message\ResponseInterface $response) use ($url) {
8686
echo $url . ': ' . $response->getBody()->getSize() . ' bytes' . PHP_EOL;
87+
}, function (Exception $e) {
88+
echo 'Error: ' . $e->getMessage() . PHP_EOL;
8789
});
8890
}
8991

9092
```
9193

92-
See also the [examples](examples).
94+
See also the [examples](examples/).
9395

9496
## Usage
9597

@@ -292,6 +294,8 @@ $promise = Queue::all(3, $urls, function ($url) use ($browser) {
292294

293295
$promise->then(function (array $responses) {
294296
echo 'All ' . count($responses) . ' successful!' . PHP_EOL;
297+
}, function (Exception $e) {
298+
echo 'Error: ' . $e->getMessage() . PHP_EOL;
295299
});
296300
```
297301

@@ -368,6 +372,8 @@ $promise = Queue::any(3, $urls, function ($url) use ($browser) {
368372

369373
$promise->then(function (ResponseInterface $response) {
370374
echo 'First response: ' . $response->getBody() . PHP_EOL;
375+
}, function (Exception $e) {
376+
echo 'Error: ' . $e->getMessage() . PHP_EOL;
371377
});
372378
```
373379

examples/01-http.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,3 @@ function (Exception $e) use ($url) {
3030
}
3131
);
3232
}
33-

examples/02-http-all.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,3 @@ function ($e) {
3232
echo 'An error occurred: ' . $e->getMessage() . PHP_EOL;
3333
}
3434
);
35-

examples/03-http-any.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@
2222
function (Psr\Http\Message\ResponseInterface $response) use ($url) {
2323
// return only the URL for the first successful response
2424
return $url;
25-
}
25+
}, function (Exception $e) {
26+
echo 'Error: ' . $e->getMessage() . PHP_EOL;
27+
}
2628
);
2729
});
2830

@@ -34,4 +36,3 @@ function ($e) {
3436
echo 'An error occurred: ' . $e->getMessage() . PHP_EOL;
3537
}
3638
);
37-

0 commit comments

Comments
 (0)