search

andriydruk / RxDNSSD

Android version of mDNSResponder
Apache License 2.0
298 stars 75 forks source link
android android-library bonjour browse-services dnssd dnssd-library hacktoberfest mdnsresponder register-service

readme

THE PROJECT IS ARCHIVED DUE TO THE RUSSIAN INVASION OF UKRAINE

🇺🇦 #StandWithUkraine

On Feb. 24, 2022 Russia declared an unprovoked war on Ukraine and launched a full-scale invasion. Russia is currently bombing peaceful Ukrainian cities, including schools and hospitals and attacking civilians who are fleeing conflict zones.

Please support Ukraine by lobbying your governments, protesting peacefully, and donating money to support the people of Ukraine. Below are links to trustworthy organizations that are helping to defend Ukraine in this unprovoked war:

Android mDNSResponder Circle CI Download Download Download

Why I created this library?

My explanation about why jmDNS, Android NSD Services and Google Nearby API are not good enough, and why I maintain this library.

Hierarchy

There are two version of mDNSReposder.

Bindable version:

                                   +--------------------+       +--------------------+
                                   |      RxDNSSD       |       |       Rx2DNSSD     |
                                   +--------------------+       +--------------------+
                                           |                            |
                                           |   +--------------------+   |
                                            -->| Android Java DNSSD |<--
                                               +--------------------+
                                               |  Apple Java DNSSD  |
                 +------------------+          +--------------------+
                 |    daemon.c      |<-------->|     mDNS Client    |
                 +------------------+          +--------------------+
                 |    mDNS Core     |
                 +------------------+
                 | Platform Support |
                 +------------------+
                    System process                Your Android app

Embedded version:

                     +--------------------+       +--------------------+
                     |      RxDNSSD       |       |       Rx2DNSSD     |
                     +--------------------+       +--------------------+
                                |                            |
                                |   +--------------------+   |
                                 -->| Android Java DNSSD |<--
                                    +--------------------+
                                    |   Apple Java DNSSD |    
                                    +--------------------+
                                    |    mDNS Client     |
                                    +--------------------+
                                    | Embedded mDNS Core |
                                    +--------------------+
                                    | Platform Support   |
                                    +--------------------+
                                      Your Android app

Binaries on MavenCentral

DNSSD library:

compile 'com.github.andriydruk:dnssd:0.9.17'

RxDNSSD library:

compile 'com.github.andriydruk:rxdnssd:0.9.17'

Rx2DNSSD library:

compile 'com.github.andriydruk:rx2dnssd:0.9.17'
./gradlew clean build

How to use

DNSSD

Dnssd library provides two implementations of DNSSD interface:

DNSSDBindable is an implementation of DNSSD with system's daemon. Use it for Android project with min API higher than 4.1 for an economy of battery consumption (Also some Samsung devices can don't work with this implementation).

[Update] Since targetSDK = 31 (Android 12) system's deamon was deprecated by Google. Consider switching to an Embedded version or some other solution.

DNSSD dnssd = new DNSSDBindable(context);

DNSSDEmbedded is an implementation of RxDnssd with embedded DNS-SD core. Can be used for any Android device with min API higher than Android 4.0.

DNSSD dnssd = new DNSSDEmbedded();
Register service
try {
    registerService = dnssd.register("service_name", "_rxdnssd._tcp", 123,  
        new RegisterListener() {

            @Override
            public void serviceRegistered(DNSSDRegistration registration, int flags, 
                String serviceName, String regType, String domain) {
                Log.i("TAG", "Register successfully ");
            }

            @Override
            public void operationFailed(DNSSDService service, int errorCode) {
                Log.e("TAG", "error " + errorCode);
            }
        });
} catch (DNSSDException e) {
    Log.e("TAG", "error", e);
}
Browse services example
try {
    browseService = dnssd.browse("_rxdnssd._tcp", new BrowseListener() {

        @Override
        public void serviceFound(DNSSDService browser, int flags, int ifIndex, 
            final String serviceName, String regType, String domain) {
            Log.i("TAG", "Found " + serviceName);
        }

        @Override
        public void serviceLost(DNSSDService browser, int flags, int ifIndex, 
            String serviceName, String regType, String domain) {
            Log.i("TAG", "Lost " + serviceName);
        }

        @Override
        public void operationFailed(DNSSDService service, int errorCode) {
            Log.e("TAG", "error: " + errorCode);
        }        
    });
} catch (DNSSDException e) {
    Log.e("TAG", "error", e);
}

You can find more samples in app inside this repository.

RxDNSSD

Register service
BonjourService bs = new BonjourService.Builder(0, 0, Build.DEVICE, "_rxdnssd._tcp", null).port(123).build();
Subscription subscription = rxdnssd.register(bonjourService)
      .observeOn(AndroidSchedulers.mainThread())
      .subscribe(service -> {
            updateUi();
      }, throwable -> {
            Log.e("DNSSD", "Error: ", throwable);
      });
Browse services example
Subscription subscription = rxDnssd.browse("_http._tcp", "local.")
    .compose(rxDnssd.resolve())
    .compose(rxDnssd.queryRecords())
    .subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(new Action1<BonjourService>() {
        @Override
        public void call(BonjourService bonjourService) {
            Log.d("TAG", bonjourService.toString());
        }
    }, new Action1<Throwable>() {
        @Override
        public void call(Throwable throwable) {
            Log.e("TAG", "error", throwable);
        }
    });

Rx2DNSSD

Register service
BonjourService bs = new BonjourService.Builder(0, 0, Build.DEVICE, "_rxdnssd._tcp", null).port(123).build();
registerDisposable = rxDnssd.register(bs)
        .subscribeOn(Schedulers.io())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(bonjourService -> {
            Log.i("TAG", "Register successfully " + bonjourService.toString());
        }, throwable -> {
            Log.e("TAG", "error", throwable);
        });
Browse services example
browseDisposable = rxDnssd.browse("_http._tcp", "local.")
        .compose(rxDnssd.resolve())
        .compose(rxDnssd.queryRecords())
        .subscribeOn(Schedulers.io())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(bonjourService -> {
            Log.d("TAG", bonjourService.toString());
            if (bonjourService.isLost()) {
                mServiceAdapter.remove(bonjourService);
            } else {
                mServiceAdapter.add(bonjourService);
            }
        }, throwable -> Log.e("TAG", "error", throwable));

License

Copyright (C) 2022 Andriy Druk

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.