clue/reactphp-mdns
, (*1)
Simple, async multicast DNS (mDNS) resolver for zeroconf networking, built on top of ReactPHP., (*2)
Multicast DNS name resolution is commonly used
as part of zeroconf networking.
It is used by Mac OS X (Bonjour), many Linux distributions (Avahi) and quite a few other networking devices such as printers, camers etc. to resolve hostnames of your local LAN clients to IP addresses., (*3)
This library implements the mDNS protocol as defined in RFC 6762.
Note that this protocol is related to, but independent of, DNS-Based Service Discovery (DNS-SD)
as defined in RFC 6763., (*4)
Table of Contents, (*5)
Note: This project is in beta stage! Feel free to report any issues you encounter., (*6)
Quickstart example
Once installed, you can use the following code to look up the address of a local domain name:, (*7)
<?php
require __DIR__ . '/vendor/autoload.php';
$factory = new Clue\React\Mdns\Factory();
$resolver = $factory->createResolver();
$resolver->resolve('hostname.local')->then(function ($ip) {
echo 'Found: ' . $ip . PHP_EOL;
}, function (Exception $e) {
echo 'Error: ' . $e->getMessage() . PHP_EOL;
});
See also the examples., (*8)
Usage
Factory
The Factory is responsible for creating your Resolver instance., (*9)
$factory = new 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.
This value SHOULD NOT be given unless you're sure you want to explicitly use a
given event loop instance., (*10)
createResolver()
The createResolver() method can be used to create a mDNS resolver instance that sends multicast DNS queries and waits for incoming unicast DNS responses. It returns a Resolver instance., (*11)
$resolver = $factory->createResolver();
Resolver
The Factory creates instances of the React\Dns\Resolver\Resolver class from the react/dns package., (*12)
While ReactPHP's normal DNS resolver uses unicast UDP messages (and TCP streams) to query a given nameserver,
this resolver instance uses multicast UDP messages to query all reachable hosts in your network., (*13)
Promises
Sending queries is async (non-blocking), so you can actually send multiple DNS queries in parallel.
The mDNS hosts will respond to each DNS query message with a DNS response message. The order is not guaranteed.
Sending queries uses a Promise-based interface that makes it easy to react to when a query is fulfilled
(i.e. either successfully resolved or rejected with an error):, (*14)
$resolver->resolve($hostname)->then(
function ($ip) {
// IP successfully resolved
},
function (Exception $e) {
// an error occurred while looking up the given hostname
}
});
Please refer to the DNS documentation for more details., (*15)
Blocking
As stated above, this library provides you a powerful, async API by default., (*16)
If, however, you want to integrate this into your traditional, blocking environment,
you should look into also using clue/reactphp-block., (*17)
The resulting blocking code could look something like this:, (*18)
<?php
require __DIR__ . '/vendor/autoload.php';
use Clue\React\Block;
$factory = new Clue\React\Mdns\Factory();
$resolver = $factory->createResolver();
$promise = $resolver->resolve('me.local');
try {
$ip = Block\await($promise, $loop);
// IP successfully resolved
} catch (Exception $e) {
// an error occurred while performing the request
}
Similarly, you can also process multiple lookups concurrently and await an array of results:, (*19)
$promises = array(
$resolver->resolve('first.local'),
$resolver->resolve('second.local'),
);
$ips = Block\awaitAll($promises, $loop);
Please refer to clue/reactphp-block for more details., (*20)
Install
The recommended way to install this library is through Composer.
New to Composer?, (*21)
composer require clue/mdns-react:~0.2.0
See also the CHANGELOG for details about version upgrades., (*22)
This project aims to run on any platform and thus does not require any PHP
extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
HHVM.
It's highly recommended to use the latest supported PHP version for this project., (*23)
Tests
To run the test suite, you first need to clone this repo and then install all
dependencies through Composer:, (*24)
composer install
To run the test suite, go to the project root and run:, (*25)
vendor/bin/phpunit
License
This project is released under the permissive MIT license., (*26)
Did you know that I offer custom development services and issuing invoices for
sponsorships of releases and for contributions? Contact me (@clue) for details., (*27)
More
Wallogit.com
