node_mdns - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #llm #golang #android #machine-learning #linux #docker #java #awesome #openai #open-source

node_mdns

(★ 877)

mdns/zeroconf/bonjour service discovery add-on for node.js

File Explorer

Download Latest Version (.zip)

- - source.ejs
  - status.ejs
- - index.ejs
  - user_guide.ejs
- config.json
- layout.ejs
- README.ejs
- express_app.js
- osc_devices.js
- advertisement.js
- avahi.js
- browser.js
- dns_sd.js
- io_watcher.js
- mdns.js
- mdns_service.js
- network_interface.js
- resolver_sequence_tasks.js
- service_type.js
- demangle.cpp
- dns_sd.cpp
- dns_service_browse.cpp
- dns_service_enumerate_domains.cpp
- dns_service_get_addr_info.cpp
- dns_service_process_result.cpp
- dns_service_ref.cpp
- dns_service_ref.hpp
- dns_service_ref_deallocate.cpp
- dns_service_ref_sock_fd.cpp
- dns_service_register.cpp
- dns_service_resolve.cpp
- dns_service_update_record.cpp
- mdns.hpp
- mdns_settings.hpp
- mdns_utils.cpp
- mdns_utils.hpp
- network_interface.cpp
- skeleton.cpp_
- socket_watcher.cpp
- socket_watcher.hpp
- txt_record_buffer_to_object.cpp
- txt_record_create.cpp
- txt_record_deallocate.cpp
- txt_record_get_length.cpp
- txt_record_ref.cpp
- txt_record_ref.hpp
- txt_record_set_value.cpp
- test_browser.js
- test_dns_sd.js
- test_functional.js
- test_mdns_service.js
- test_network_interface.js
- test_odd_ends.js
- test_service_type.js
- - actors.js
  - bunch.js
  - compiler.js
  - lcov.js
  - mdns_test.js
  - ncov.js
  - obj.js
  - view.js
- coverage
- docpack
- jsf
- ncov
- render_report
- testrun
.gitignore
.npmignore
binding.gyp
CHANGES
LICENSE
Makefile
node-waf.bat
package-lock.json
package.json
README.md
wscript

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# mdns -- node.js Service Discovery

* Package: mdns
* Description: multicast DNS service discovery
* Installation: `npm install mdns` (see below)
* Documentation: [mdns user guide](http://agnat.github.io/node_mdns/user_guide.html)
* License: [MIT](http://github.com/agnat/node_mdns/blob/master/LICENSE)
* Donations: [![Flattr this git repository](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=agnat&url=https://github.com/agnat/node_mdns&title=node_mdns&tags=github&category=software)

mdns adds multicast DNS service discovery, also known as zeroconf or bonjour to Node.js. It provides an object based interface to announce and browse services on the local network.

## Synopsis

```js
// import the module
const mdns = require('mdns');

// advertise a http server on port 4321
const ad = mdns.createAdvertisement(mdns.tcp('http'), 4321);
ad.start();

// watch all http servers
const browser = mdns.createBrowser(mdns.tcp('http'));
browser.on('serviceUp', service => {
  console.log("service up: ", service);
});
browser.on('serviceDown', service => {
  console.log("service down: ", service);
});
browser.start();

// discover all available service types
const all_the_types = mdns.browseThemAll(); // all_the_types is just another browser...
```

## Installation

On Linux and other systems using the avahi daemon the avahi dns_sd compat library and its header files are required.  On debianesque systems the package name is `libavahi-compat-libdnssd-dev`, on fedoraesque systems the package is `avahi-compat-libdns_sd-devel`.  On other platforms Apple's [mDNSResponder](http://opensource.apple.com/tarballs/mDNSResponder/) is recommended. Care should be taken not to install more than one mDNS stack on a system.

On Windows you are going to need Apples "Bonjour SDK for Windows". You can download it either from [Apple](https://developer.apple.com/download/more/?=Bonjour%20SDK%20for%20Windows) (registration required) or various unofficial sources. Take your pick. After installing the SDK restart your computer and make sure the `BONJOUR_SDK_HOME` environment variable is set. You'll also need a compiler. Microsoft Visual Studio Express will do. On Windows node >=0.7.9 is required.

mdns is available as a npm package:

```sh
npm install mdns
```

If you want to play with the latest source code, here is a more manual approach:

```sh
git clone http://github.com/agnat/node_mdns
cd node_mdns
npm link && npm test
```

In case you want to run or even publish your package using the development version of mdns you may set the version field to a tarball URL:

```json
{ "name": "discomvobulator"
, "version": "0.0.1"
, "description": "covers all your discomvobulation needs"
, "dependencies":
  { "mdns": "https://github.com/agnat/node_mdns/tarball/master"
  }
}
```

## Documentation

See the [user guide](http://agnat.github.io/node_mdns/user_guide.html).

## Contributors

In random order:

* Orlando Vazquez ([orlandov](https://github.com/orlandov))
* Ryan Dahl ([ry](https://github.com/ry))
* Dominic Tarr ([dominictarr](https://github.com/dominictarr))
* Emil Stenqvist ([emilisto](https://github.com/emilisto))
* Toby Ealden ([TobyEalden](https://github.com/TobyEalden))
* Ron Korving ([ronkorving](https://github.com/ronkorving))
* Don Park ([donpark](https://github.com/donpark))
* Cong Liu ([ghostoy](https://github.com/ghostoy))
* Tian Zhang ([KhaosT](https://github.com/KhaosT))

Your name is missing on the list? Shame on me. Please open an issue.

## Bugs and Contributions

If you find a bug, please report it using the [issue tracker](http://github.com/agnat/node_mdns/issues).