Skip to content

Commit c830c6f

Browse files
jsorjsor
authored
Merge pull request #103 from clue-labs/udp
Rename DatagramTransportExecutor to UdpTransportExecutor
2 parents bfae657 + cdf5d3e commit c830c6f

6 files changed

Lines changed: 34 additions & 34 deletions

File tree

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ easily be used to create a DNS server.
1414
* [Caching](#caching)
1515
* [Custom cache adapter](#custom-cache-adapter)
1616
* [Advanced usage](#advanced-usage)
17-
* [DatagramTransportExecutor](#datagramtransportexecutor)
17+
* [UdpTransportExecutor](#udptransportexecutor)
1818
* [HostsFileExecutor](#hostsfileexecutor)
1919
* [Install](#install)
2020
* [Tests](#tests)
@@ -118,10 +118,10 @@ See also the wiki for possible [cache implementations](https://github.com/reactp
118118

119119
## Advanced Usage
120120

121-
### DatagramTransportExecutor
121+
### UdpTransportExecutor
122122

123-
The `DatagramTransportExecutor` can be used to
124-
send DNS queries over a datagram transport such as UDP.
123+
The `UdpTransportExecutor` can be used to
124+
send DNS queries over a UDP transport.
125125

126126
This is the main class that sends a DNS query to your DNS server and is used
127127
internally by the `Resolver` for the actual message transport.
@@ -131,7 +131,7 @@ The following example looks up the `IPv6` address for `igor.io`.
131131

132132
```php
133133
$loop = Factory::create();
134-
$executor = new DatagramTransportExecutor($loop);
134+
$executor = new UdpTransportExecutor($loop);
135135

136136
$executor->query(
137137
'8.8.8.8:53',
@@ -152,7 +152,7 @@ want to use this in combination with a `TimeoutExecutor` like this:
152152

153153
```php
154154
$executor = new TimeoutExecutor(
155-
new DatagramTransportExecutor($loop),
155+
new UdpTransportExecutor($loop),
156156
3.0,
157157
$loop
158158
);
@@ -165,7 +165,7 @@ combination with a `RetryExecutor` like this:
165165
```php
166166
$executor = new RetryExecutor(
167167
new TimeoutExecutor(
168-
new DatagramTransportExecutor($loop),
168+
new UdpTransportExecutor($loop),
169169
3.0,
170170
$loop
171171
)
@@ -180,14 +180,14 @@ $executor = new RetryExecutor(
180180

181181
### HostsFileExecutor
182182

183-
Note that the above `Executor` class always performs an actual DNS query.
183+
Note that the above `UdpTransportExecutor` class always performs an actual DNS query.
184184
If you also want to take entries from your hosts file into account, you may
185185
use this code:
186186

187187
```php
188188
$hosts = \React\Dns\Config\HostsFile::loadFromPathBlocking();
189189

190-
$executor = new Executor($loop, new Parser(), new BinaryDumper(), null);
190+
$executor = new UdpTransportExecutor($loop);
191191
$executor = new HostsFileExecutor($hosts, $executor);
192192

193193
$executor->query(

‎examples/04-query-a-and-aaaa.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<?php
22

33
use React\Dns\Model\Message;
4-
use React\Dns\Query\DatagramTransportExecutor;
54
use React\Dns\Query\Query;
5+
use React\Dns\Query\UdpTransportExecutor;
66
use React\EventLoop\Factory;
77

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

1010
$loop = Factory::create();
11-
$executor = new DatagramTransportExecutor($loop);
11+
$executor = new UdpTransportExecutor($loop);
1212

1313
$name = isset($argv[1]) ? $argv[1] : 'www.google.com';
1414

‎src/Query/Executor.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
/**
1515
* @deprecated unused, exists for BC only
16-
* @see DatagramTransportExecutor
16+
* @see UdpTransportExecutor
1717
*/
1818
class Executor implements ExecutorInterface
1919
{

src/Query/DatagramTransportExecutor.php renamed to src/Query/UdpTransportExecutor.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
use React\Promise\Deferred;
1010

1111
/**
12-
* Send DNS queries over a datagram transport such as UDP.
12+
* Send DNS queries over a UDP transport.
1313
*
1414
* This is the main class that sends a DNS query to your DNS server and is used
1515
* internally by the `Resolver` for the actual message transport.
@@ -19,11 +19,11 @@
1919
*
2020
* ```php
2121
* $loop = Factory::create();
22-
* $executor = new DatagramTransportExecutor($loop);
22+
* $executor = new UdpTransportExecutor($loop);
2323
*
2424
* $executor->query(
2525
* '8.8.8.8:53',
26-
* new Query($name, Message::TYPE_AAAA, Message::CLASS_IN, time())
26+
* new Query($name, Message::TYPE_AAAA, Message::CLASS_IN)
2727
* )->then(function (Message $message) {
2828
* foreach ($message->answers as $answer) {
2929
* echo 'IPv6: ' . $answer->data . PHP_EOL;
@@ -40,7 +40,7 @@
4040
*
4141
* ```php
4242
* $executor = new TimeoutExecutor(
43-
* new DatagramTransportExecutor($loop),
43+
* new UdpTransportExecutor($loop),
4444
* 3.0,
4545
* $loop
4646
* );
@@ -53,7 +53,7 @@
5353
* ```php
5454
* $executor = new RetryExecutor(
5555
* new TimeoutExecutor(
56-
* new DatagramTransportExecutor($loop),
56+
* new UdpTransportExecutor($loop),
5757
* 3.0,
5858
* $loop
5959
* )
@@ -66,7 +66,7 @@
6666
* packages. Higher-level components should take advantage of the Datagram
6767
* component instead of reimplementing this socket logic from scratch.
6868
*/
69-
class DatagramTransportExecutor implements ExecutorInterface
69+
class UdpTransportExecutor implements ExecutorInterface
7070
{
7171
private $loop;
7272
private $parser;

‎src/Resolver/Factory.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
use React\Cache\CacheInterface;
77
use React\Dns\Config\HostsFile;
88
use React\Dns\Query\CachedExecutor;
9-
use React\Dns\Query\DatagramTransportExecutor;
109
use React\Dns\Query\ExecutorInterface;
1110
use React\Dns\Query\HostsFileExecutor;
1211
use React\Dns\Query\RecordCache;
1312
use React\Dns\Query\RetryExecutor;
1413
use React\Dns\Query\TimeoutExecutor;
14+
use React\Dns\Query\UdpTransportExecutor;
1515
use React\EventLoop\LoopInterface;
1616

1717
class Factory
@@ -69,7 +69,7 @@ private function decorateHostsFileExecutor(ExecutorInterface $executor)
6969
protected function createExecutor(LoopInterface $loop)
7070
{
7171
return new TimeoutExecutor(
72-
new DatagramTransportExecutor($loop),
72+
new UdpTransportExecutor($loop),
7373
5.0,
7474
$loop
7575
);

tests/Query/DatagramTransportExecutorTest.php renamed to tests/Query/UdpTransportExecutorTest.php

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
namespace React\Tests\Dns\Query;
44

5-
use React\Tests\Dns\TestCase;
6-
use React\Dns\Query\DatagramTransportExecutor;
7-
use React\Dns\Query\Query;
85
use React\Dns\Model\Message;
9-
use React\EventLoop\Factory;
10-
use React\Dns\Protocol\Parser;
116
use React\Dns\Protocol\BinaryDumper;
7+
use React\Dns\Protocol\Parser;
8+
use React\Dns\Query\Query;
9+
use React\Dns\Query\UdpTransportExecutor;
10+
use React\EventLoop\Factory;
11+
use React\Tests\Dns\TestCase;
1212

13-
class DatagramTransportExecutorTest extends TestCase
13+
class UdpTransportExecutorTest extends TestCase
1414
{
1515
public function testQueryRejectsIfMessageExceedsUdpSize()
1616
{
@@ -20,7 +20,7 @@ public function testQueryRejectsIfMessageExceedsUdpSize()
2020
$dumper = $this->getMockBuilder('React\Dns\Protocol\BinaryDumper')->getMock();
2121
$dumper->expects($this->once())->method('toBinary')->willReturn(str_repeat('.', 513));
2222

23-
$executor = new DatagramTransportExecutor($loop, null, $dumper);
23+
$executor = new UdpTransportExecutor($loop, null, $dumper);
2424

2525
$query = new Query('google.com', Message::TYPE_A, Message::CLASS_IN);
2626
$promise = $executor->query('8.8.8.8:53', $query);
@@ -34,7 +34,7 @@ public function testQueryRejectsIfServerConnectionFails()
3434
$loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
3535
$loop->expects($this->never())->method('addReadStream');
3636

37-
$executor = new DatagramTransportExecutor($loop);
37+
$executor = new UdpTransportExecutor($loop);
3838

3939
$query = new Query('google.com', Message::TYPE_A, Message::CLASS_IN);
4040
$promise = $executor->query('///', $query);
@@ -52,7 +52,7 @@ public function testQueryRejectsOnCancellation()
5252
$loop->expects($this->once())->method('addReadStream');
5353
$loop->expects($this->once())->method('removeReadStream');
5454

55-
$executor = new DatagramTransportExecutor($loop);
55+
$executor = new UdpTransportExecutor($loop);
5656

5757
$query = new Query('google.com', Message::TYPE_A, Message::CLASS_IN);
5858
$promise = $executor->query('8.8.8.8:53', $query);
@@ -66,7 +66,7 @@ public function testQueryKeepsPendingIfServerRejectsNetworkPacket()
6666
{
6767
$loop = Factory::create();
6868

69-
$executor = new DatagramTransportExecutor($loop);
69+
$executor = new UdpTransportExecutor($loop);
7070

7171
$query = new Query('google.com', Message::TYPE_A, Message::CLASS_IN);
7272

@@ -94,7 +94,7 @@ public function testQueryKeepsPendingIfServerSendInvalidMessage()
9494
});
9595

9696
$address = stream_socket_get_name($server, false);
97-
$executor = new DatagramTransportExecutor($loop);
97+
$executor = new UdpTransportExecutor($loop);
9898

9999
$query = new Query('google.com', Message::TYPE_A, Message::CLASS_IN);
100100

@@ -129,7 +129,7 @@ public function testQueryKeepsPendingIfServerSendInvalidId()
129129
});
130130

131131
$address = stream_socket_get_name($server, false);
132-
$executor = new DatagramTransportExecutor($loop, $parser, $dumper);
132+
$executor = new UdpTransportExecutor($loop, $parser, $dumper);
133133

134134
$query = new Query('google.com', Message::TYPE_A, Message::CLASS_IN);
135135

@@ -164,7 +164,7 @@ public function testQueryRejectsIfServerSendsTruncatedResponse()
164164
});
165165

166166
$address = stream_socket_get_name($server, false);
167-
$executor = new DatagramTransportExecutor($loop, $parser, $dumper);
167+
$executor = new UdpTransportExecutor($loop, $parser, $dumper);
168168

169169
$query = new Query('google.com', Message::TYPE_A, Message::CLASS_IN);
170170

@@ -203,7 +203,7 @@ public function testQueryResolvesIfServerSendsValidResponse()
203203
});
204204

205205
$address = stream_socket_get_name($server, false);
206-
$executor = new DatagramTransportExecutor($loop, $parser, $dumper);
206+
$executor = new UdpTransportExecutor($loop, $parser, $dumper);
207207

208208
$query = new Query('google.com', Message::TYPE_A, Message::CLASS_IN);
209209

0 commit comments

Comments
 (0)