Skip to content

Commit

Permalink
Improve documentation and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
yadaiio committed Mar 12, 2024
1 parent bc01ce1 commit 7872737
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 16 deletions.
10 changes: 8 additions & 2 deletions README.md
Expand Up @@ -10,7 +10,7 @@ built on top of [ReactPHP](https://reactphp.org/).
Let's say you crawl a page and find that you need to send 100 HTTP requests to
following pages which each takes `0.2s`. You can either send them all
sequentially (taking around `20s`) or you can use
[ReactPHP](https://reactphp.org) to concurrently request all your pages at the
[ReactPHP](https://reactphp.org/) to concurrently request all your pages at the
same time. This works perfectly fine for a small number of operations, but
sending an excessive number of requests can either take up all resources on your
side or may get you banned by the remote side as it sees an unreasonable number
Expand Down Expand Up @@ -84,12 +84,14 @@ $q = new Clue\React\Mq\Queue(3, null, function ($url) use ($browser) {
foreach ($urls as $url) {
$q($url)->then(function (Psr\Http\Message\ResponseInterface $response) use ($url) {
echo $url . ': ' . $response->getBody()->getSize() . ' bytes' . PHP_EOL;
}, function (Exception $e) {
echo 'Error: ' . $e->getMessage() . PHP_EOL;
});
}

```

See also the [examples](examples).
See also the [examples](examples/).

## Usage

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

$promise->then(function (array $responses) {
echo 'All ' . count($responses) . ' successful!' . PHP_EOL;
}, function (Exception $e) {
echo 'Error: ' . $e->getMessage() . PHP_EOL;
});
```

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

$promise->then(function (ResponseInterface $response) {
echo 'First response: ' . $response->getBody() . PHP_EOL;
}, function (Exception $e) {
echo 'Error: ' . $e->getMessage() . PHP_EOL;
});
```

Expand Down
6 changes: 2 additions & 4 deletions examples/01-http.php
Expand Up @@ -24,10 +24,8 @@
$queue($url)->then(
function (Psr\Http\Message\ResponseInterface $response) use ($url) {
echo $url . ' has ' . $response->getBody()->getSize() . ' bytes' . PHP_EOL;
},
function (Exception $e) use ($url) {
echo $url . ' failed: ' . $e->getMessage() . PHP_EOL;
}, function (Exception $e) {
echo 'Error: ' . $e->getMessage() . PHP_EOL;
}
);
}

6 changes: 2 additions & 4 deletions examples/02-http-all.php
Expand Up @@ -27,9 +27,7 @@ function ($responses) {
foreach ($responses as $url => $response) {
echo $url . ' has ' . $response->getBody()->getSize() . ' bytes' . PHP_EOL;
}
},
function ($e) {
echo 'An error occurred: ' . $e->getMessage() . PHP_EOL;
}, function (Exception $e) {
echo 'Error: ' . $e->getMessage() . PHP_EOL;
}
);

9 changes: 3 additions & 6 deletions examples/03-http-any.php
Expand Up @@ -22,16 +22,13 @@
function (Psr\Http\Message\ResponseInterface $response) use ($url) {
// return only the URL for the first successful response
return $url;
}
);
});
});

$promise->then(
function ($url) {
echo 'First successful URL is ' . $url . PHP_EOL;
},
function ($e) {
echo 'An error occurred: ' . $e->getMessage() . PHP_EOL;
}, function (Exception $e) {
echo 'Error: ' . $e->getMessage() . PHP_EOL;
}
);

0 comments on commit 7872737

Please sign in to comment.