https://github.com/vstirbu/zeroconf
ZeroConf plugin for Cordova/Phonegap 3.0
https://github.com/vstirbu/zeroconf
cordova-android cordova-plugin zeroconf
Last synced: 5 months ago
JSON representation
ZeroConf plugin for Cordova/Phonegap 3.0
- Host: GitHub
- URL: https://github.com/vstirbu/zeroconf
- Owner: vstirbu
- License: mit
- Created: 2013-12-18T07:03:01.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-03-16T17:11:27.000Z (over 8 years ago)
- Last Synced: 2025-04-09T14:05:27.592Z (6 months ago)
- Topics: cordova-android, cordova-plugin, zeroconf
- Language: Java
- Homepage:
- Size: 451 KB
- Stars: 37
- Watchers: 3
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# ZeroConf plugin for Cordova/Phonegap #
This plugin allows you to browse and publish ZeroConf/Bonjour/mDNS services from applications developed using PhoneGap/Cordova 3.0 or newer. For older versions use [ZeroConf](https://github.com/purplecabbage/phonegap-plugins/tree/master/Android/ZeroConf).
[](http://badge.fury.io/gh/vstirbu%2FZeroConf)
## Adding the Plugin to your project ##
In your application project directory, if you use `cordova-cli` newer then 5.0:
```bash
cordova plugin add cordova-zeroconf-plugin
```
or, for older versions:
```bash
cordova plugin add https://github.com/vstirbu/ZeroConf@1.1.1
```
## Using the plugin ##
There are six static methods on the ZeroConf object, as follows:
### `watch(type, callback)`
Note that `type` is a fully-qualified service type, including the domain, e.g. `"_http._tcp.local."`
`callback` is a function that is called when services are added and removed. The function is passed
an object with the following structure:
```javascript
{
"service": {
"port": 50930,
"protocol": "tcp",
"application": "http",
"urls": ["http://192.168.2.2:50930", "http://fe80::7256:81ff:fe00:99e3:50930"],
"description": "\\00",
"name": "Black iPod",
"domain": "local",
"server": "",
"addresses": ["192.168.2.2", "fe80::7256:81ff:fe00:99e3"],
"type": "_http._tcp.local.",
"qualifiedname": "Black iPod._http._tcp.local."
},
"action": "added"
}
```
For more information on the fields, see [the JmDNS docs](http://jmdns.sourceforge.net/apidocs/javax/jmdns/ServiceInfo.html).
If you edit ZeroConf.java, you can easily add more fields if you need them.
### `unwatch(type)`
Stops watching for services of the specified type.
### `close()`
Closes the service browser and stops watching.
### `register(type, name, port, text)`
Publishes a new service. The fields are as in the structure above. For more information,
see [the JmDNS docs](http://jmdns.sourceforge.net/apidocs/javax/jmdns/ServiceInfo.html).
### `unregister()`
Unregisters all published services.
### `list(type, timeout, success, error)`
List all published services, search for timeout (in ms). The fields are as in the structure above.
## Credits
Original plugin [ZeroConf](https://github.com/purplecabbage/phonegap-plugins/tree/master/Android/ZeroConf) developed by [Matt Kane](https://github.com/ascorbic) / [Triggertrap Ltd](https://github.com/triggertrap).
It depends on [the JmDNS library](http://jmdns.sourceforge.net/).
## Licence ##
The MIT License