Merge pull request #48 from stephenrauch/Find-Service-Types

stephenrauch · web-flow · commit 1dfc40f4da14 · 2016-06-21T23:11:35.000-07:00
Find service types
diff --git a/README.rst b/README.rst
@@ -110,6 +110,13 @@ Here's an example:
     If you want to customize that you need to specify ``interfaces`` argument when
     constructing ``Zeroconf`` object (see the code for details).
 
+If you don't know the name of the service you need to browse for, try:
+
+.. code-block:: python
+
+    from zeroconf import ZeroconfServiceTypes
+    print('\n'.join(ZeroconfServiceTypes.find()))
+
 See examples directory for more.
 
 Changelog
diff --git a/test_zeroconf.py b/test_zeroconf.py
@@ -21,6 +21,7 @@
     ServiceInfo,
     ServiceStateChange,
     Zeroconf,
+    ZeroconfServiceTypes,
 )
 
 log = logging.getLogger('zeroconf')
@@ -159,6 +160,33 @@ def test_bad_service_info_name(self):
         browser.close()
 
 
+class ServiceTypesQuery(unittest.TestCase):
+
+    def test_integration_with_listener(self):
+
+        type_ = "_test_service_type._tcp.local."
+        name = "xxxyyy"
+        registration_name = "%s.%s" % (name, type_)
+
+        zeroconf_registrar = Zeroconf(interfaces=['127.0.0.1'])
+        desc = {'path': '/~paulsm/'}
+        info = ServiceInfo(
+            type_, registration_name,
+            socket.inet_aton("10.0.1.2"), 80, 0, 0,
+            desc, "ash-2.local.")
+        zeroconf_registrar.register_service(info)
+
+        try:
+            service_types = ZeroconfServiceTypes.find(timeout=0.5)
+            assert type_ in service_types
+            service_types = ZeroconfServiceTypes.find(
+                zc=zeroconf_registrar, timeout=0.5)
+            assert type_ in service_types
+
+        finally:
+            zeroconf_registrar.close()
+
+
 class Listener(unittest.TestCase):
 
     def test_integration_with_listener_class(self):
diff --git a/zeroconf.py b/zeroconf.py
@@ -1256,6 +1256,46 @@ def __repr__(self):
         )
 
 
+class ZeroconfServiceTypes(object):
+    """
+    Return all of the advertised services on any local networks
+    """
+    def __init__(self):
+        self.found_services = set()
+
+    def add_service(self, zc, type_, name):
+        self.found_services.add(name)
+
+    def remove_service(self, zc, type_, name):
+        pass
+
+    @classmethod
+    def find(cls, zc=None, timeout=5):
+        """
+        Return all of the advertised services on any local networks.
+
+        :param zc: Zeroconf() instance.  Pass in if already have an
+                instance running or if non-default interfaces are needed
+        :param timeout: seconds to wait for any responses
+        :return: tuple of service type strings
+        """
+        local_zc = zc or Zeroconf()
+        listener = cls()
+        browser = ServiceBrowser(
+            local_zc, '_services._dns-sd._udp.local.', listener=listener)
+
+        # wait for responses
+        time.sleep(timeout)
+
+        # close down anything we opened
+        if zc is None:
+            local_zc.close()
+        else:
+            browser.cancel()
+
+        return tuple(sorted(listener.found_services))
+
+
 @enum.unique
 class InterfaceChoice(enum.Enum):
     Default = 1
