Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify usage by supporting new default loop #70

Merged
merged 1 commit into from
Jul 16, 2021
Merged

Simplify usage by supporting new default loop #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,7 @@ Once [installed](#install), you can use the following code to access your local
Asterisk instance and issue some simple commands via AMI:

```php
$loop = React\EventLoop\Factory::create();
$factory = new Clue\React\Ami\Factory($loop);
$factory = new Clue\React\Ami\Factory();

$factory->createClient('user:secret@localhost')->then(function (Clue\React\Ami\Client $client) {
echo 'Client connected' . PHP_EOL;
Expand All @@ -91,8 +90,6 @@ $factory->createClient('user:secret@localhost')->then(function (Clue\React\Ami\C
var_dump($response);
});
});

$loop->run();
```

See also the [examples](examples).
Expand All @@ -102,19 +99,23 @@ See also the [examples](examples).
### Factory

The `Factory` is responsible for creating your [`Client`](#client) instance.
It also registers everything with the main [`EventLoop`](https://github.com/reactphp/event-loop#usage).

```php
$loop = React\EventLoop\Factory::create();
$factory = new Clue\React\Ami\Factory($loop);
$factory = new Clue\React\Ami\Factory();
```

This class takes an optional `LoopInterface|null $loop` parameter that can be used to
pass the event loop instance to use for this object. You can use a `null` value
here in order to use the [default loop](https://github.com/reactphp/event-loop#loop).
This value SHOULD NOT be given unless you're sure you want to explicitly use a
given event loop instance.

If you need custom connector settings (DNS resolution, TLS parameters, timeouts,
proxy servers etc.), you can explicitly pass a custom instance of the
[`ConnectorInterface`](https://github.com/reactphp/socket#connectorinterface):

```php
$connector = new React\Socket\Connector($loop, array(
$connector = new React\Socket\Connector(null, array(
'dns' => '127.0.0.1',
'tcp' => array(
'bindto' => '192.168.10.1:0'
Expand All @@ -125,7 +126,7 @@ $connector = new React\Socket\Connector($loop, array(
)
));

$factory = new Clue\React\Ami\Factory($loop, $connector);
$factory = new Clue\React\Ami\Factory(null, $connector);
```

#### createClient()
Expand Down Expand Up @@ -374,11 +375,11 @@ The resulting blocking code could look something like this:

```php
use Clue\React\Block;
use React\EventLoop\Loop;

function getSipPeers()
{
$loop = React\EventLoop\Factory::create();
$factory = new Clue\React\Ami\Factory($loop);
$factory = new Clue\React\Ami\Factory();

$target = 'name:password@localhost';
$promise = $factory->createClient($target)->then(function (Clue\React\Ami\Client $client) {
Expand All @@ -390,7 +391,7 @@ function getSipPeers()
return $ret;
});

return Block\await($promise, $loop, 5.0);
return Block\await($promise, Loop::get(), 5.0);
}
```

Expand Down
4 changes: 2 additions & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
"require": {
"php": ">=5.3",
"evenement/evenement": "^3.0 || ^2.0 || ^1.0",
"react/event-loop": "^1.0 || ^0.5 || ^0.4 || ^0.3",
"react/event-loop": "^1.2",
"react/promise": "^2.0 || ^1.1",
"react/socket": "^1.0 || ^0.8.2"
"react/socket": "^1.8"
},
"require-dev": {
"clue/block-react": "^1.2",
Expand Down
14 changes: 6 additions & 8 deletions examples/commands.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
use Clue\React\Ami\Client;
use Clue\React\Ami\ActionSender;
use Clue\React\Ami\Protocol\Response;
use React\EventLoop\Loop;

require __DIR__ . '/../vendor/autoload.php';

$loop = React\EventLoop\Factory::create();
$factory = new Factory($loop);
$factory = new Factory();

$target = isset($argv[1]) ? $argv[1] : 'name:password@localhost';

$factory->createClient($target)->then(function (Client $client) use ($loop) {
$factory->createClient($target)->then(function (Client $client) {
echo 'Client connected. Use STDIN to send CLI commands via asterisk AMI.' . PHP_EOL;
$sender = new ActionSender($client);

Expand All @@ -22,13 +22,13 @@
echo 'Commands: ' . implode(', ', array_keys($response->getFields())) . PHP_EOL;
});

$client->on('close', function() use ($loop) {
$client->on('close', function() {
echo 'Closed' . PHP_EOL;

$loop->removeReadStream(STDIN);
Loop::removeReadStream(STDIN);
});

$loop->addReadStream(STDIN, function () use ($sender) {
Loop::addReadStream(STDIN, function () use ($sender) {
$line = trim(fread(STDIN, 4096));
echo '<' . $line . PHP_EOL;

Expand All @@ -42,5 +42,3 @@ function (Exception $error) use ($line) {
);
});
}, 'var_dump');

$loop->run();
7 changes: 2 additions & 5 deletions examples/events.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,12 @@

require __DIR__ . '/../vendor/autoload.php';

$loop = React\EventLoop\Factory::create();
$factory = new Factory($loop);
$factory = new Factory();

$target = isset($argv[1]) ? $argv[1] : 'name:password@localhost';

$factory->createClient($target)->then(
function (Client $client) use ($loop) {
function (Client $client) {
echo 'Client connected ' . PHP_EOL;

$sender = new ActionSender($client);
Expand All @@ -32,5 +31,3 @@ function (Exception $error) {
echo 'Connection error: ' . $error;
}
);

$loop->run();
7 changes: 2 additions & 5 deletions examples/peers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,11 @@

require __DIR__ . '/../vendor/autoload.php';

$loop = React\EventLoop\Factory::create();
$factory = new Factory($loop);
$factory = new Factory();

$target = isset($argv[1]) ? $argv[1] : 'name:password@localhost';

$factory->createClient($target)->then(function (Client $client) use ($loop) {
$factory->createClient($target)->then(function (Client $client) {
echo 'Successfully connected' . PHP_EOL;

$collector = new ActionSender($client);
Expand All @@ -24,5 +23,3 @@
echo 'found ' . count($peers) . ' peers' . PHP_EOL;
});
}, 'var_dump');

$loop->run();
16 changes: 10 additions & 6 deletions src/Factory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,23 @@

/**
* The `Factory` is responsible for creating your [`Client`](#client) instance.
* It also registers everything with the main [`EventLoop`](https://github.com/reactphp/event-loop#usage).
*
* ```php
* $loop = React\EventLoop\Factory::create();
* $factory = new Clue\React\Ami\Factory($loop);
* $factory = new Clue\React\Ami\Factory();
* ```
*
* This class takes an optional `LoopInterface|null $loop` parameter that can be used to
* pass the event loop instance to use for this object. You can use a `null` value
* here in order to use the [default loop](https://github.com/reactphp/event-loop#loop).
* This value SHOULD NOT be given unless you're sure you want to explicitly use a
* given event loop instance.
*
* If you need custom connector settings (DNS resolution, TLS parameters, timeouts,
* proxy servers etc.), you can explicitly pass a custom instance of the
* [`ConnectorInterface`](https://github.com/reactphp/socket#connectorinterface):
*
* ```php
* $connector = new React\Socket\Connector($loop, array(
* $connector = new React\Socket\Connector(null, array(
* 'dns' => '127.0.0.1',
* 'tcp' => array(
* 'bindto' => '192.168.10.1:0'
Expand All @@ -32,14 +36,14 @@
* )
* ));
*
* $factory = new Clue\React\Ami\Factory($loop, $connector);
* $factory = new Clue\React\Ami\Factory(null, $connector);
* ```
*/
class Factory
{
private $connector;

public function __construct(LoopInterface $loop, ConnectorInterface $connector = null)
public function __construct(LoopInterface $loop = null, ConnectorInterface $connector = null)
{
if ($connector === null) {
$connector = new Connector($loop);
Expand Down
6 changes: 2 additions & 4 deletions tests/FactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,14 @@ class FactoryTest extends TestCase
*/
public function setUpFactory()
{
$loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
$this->tcp = $this->getMockBuilder('React\Socket\ConnectorInterface')->getMock();

$this->factory = new Factory($loop, $this->tcp);
$this->factory = new Factory(null, $this->tcp);
}

public function testDefaultCtorCreatesConnectorAutomatically()
{
$loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
$this->factory = new Factory($loop);
$this->factory = new Factory();

$ref = new \ReflectionProperty($this->factory, 'connector');
$ref->setAccessible(true);
Expand Down