In-browser DNS-based service discovery system

chrome/browser/local_discovery/service_discovery_client_impl.h

+// Copyright (c) 2013 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef CHROME_BROWSER_LOCAL_DISCOVERY_SERVICE_DISCOVERY_CLIENT_IMPL_H_
+#define CHROME_BROWSER_LOCAL_DISCOVERY_SERVICE_DISCOVERY_CLIENT_IMPL_H_
+
+#include <map>
+#include <string>
+#include <vector>
+
+#include "base/callback.h"
+#include "base/cancelable_callback.h"
+#include "base/memory/weak_ptr.h"
+#include "base/message_loop.h"
+#include "chrome/browser/local_discovery/service_discovery_client.h"
+#include "net/dns/mdns_client.h"
+
+namespace local_discovery {
+
+class ServiceDiscoveryClientImpl : public ServiceDiscoveryClient {
+ public:
+  ServiceDiscoveryClientImpl();
+  virtual ~ServiceDiscoveryClientImpl();
+
+  // Create a service object listening for DNS-SD service announcements on
+  // service type |service_type|.
+  virtual scoped_ptr<ServiceWatcher> CreateServiceWatcher(
+      const std::string& service_type,
+      ServiceWatcher::Delegate* delegate) OVERRIDE;
+
+  // Create a service object listening for DNS-SD service announcements on

[gene, 2013/06/18 23:46:53]

Comment is for a listener here.

[Noam Samuel, 2013/06/19 18:46:22]

Removed comments on implementation and added references to originals, matching
the style in the mDNS library.

+  // service |service_name|. |delegate| may be null in which case the
+  // object will not recieve continuous announcements but may still query
+  // about the relevant service.
+  virtual scoped_ptr<ServiceResolver> CreateServiceResolver(
+      const std::string& service_name,
+      const ServiceResolver::ResolveCompleteCallback& callback) OVERRIDE;
+
+  static ServiceDiscoveryClientImpl* GetInstance();
+ private:
+  DISALLOW_COPY_AND_ASSIGN(ServiceDiscoveryClientImpl);
+};
+
+class ServiceWatcherImpl : public ServiceWatcher,
+                               public net::MDnsListener::Delegate {
+ public:
+  ServiceWatcherImpl(const std::string& service_type,
+                     ServiceWatcher::Delegate* delegate);
+  // Listening will automatically stop when the destructor is called.
+  virtual ~ServiceWatcherImpl();
+
+  virtual bool Start() OVERRIDE;
+
+  // Get all known services names of this watcher's type. Return them in
+  // |services|.
+  virtual void GetAvailableServices(
+      std::vector<std::string>* services) const OVERRIDE;
+
+  // Probe for services of this type.
+  virtual void DiscoverNewServices(bool force_update) OVERRIDE;
+
+  virtual std::string GetServiceType() const OVERRIDE;
+
+  virtual void ReadCachedServices() OVERRIDE;
+
+  virtual void OnRecordUpdate(net::MDnsListener::UpdateType update,
+                              const net::RecordParsed* record) OVERRIDE;
+
+  virtual void OnNsecRecord(const std::string& name, unsigned rrtype) OVERRIDE;
+
+  virtual void OnCachePurged() OVERRIDE;
+
+  virtual void OnTransactionResponse(
+      scoped_ptr<net::MDnsTransaction>* transaction,
+      net::MDnsTransaction::Result result,
+      const net::RecordParsed* record);
+
+ private:
+  struct ServiceListeners {
+    ServiceListeners(const std::string& service_name,
+                     ServiceWatcherImpl* watcher);
+    ~ServiceListeners();
+    bool Start();
+
+   private:
+    scoped_ptr<net::MDnsListener> srv_listener_;
+    scoped_ptr<net::MDnsListener> txt_listener_;
+  };
+
+  void AddService(const std::string& service);
+  void RemoveService(const std::string& service);
+  bool CreateTransaction(bool active, bool alert_existing_services,
+                         bool force_refresh,
+                         scoped_ptr<net::MDnsTransaction>* transaction);
+
+  std::string service_type_;
+  std::map<std::string, ServiceListeners*> services_;

[Vitaly Buka (NO REVIEWS), 2013/06/18 23:01:46]

Please define typedef for td::map<std::string, ServiceListeners*>
and use everywhere

[Noam Samuel, 2013/06/19 18:46:22]

Done.

+  scoped_ptr<net::MDnsTransaction> transaction_network_;
+  scoped_ptr<net::MDnsTransaction> transaction_cache_;
+  scoped_ptr<net::MDnsListener> listener_;
+
+  ServiceWatcher::Delegate* delegate_;
+  bool started_;
+
+  DISALLOW_COPY_AND_ASSIGN(ServiceWatcherImpl);
+};
+
+
+class ServiceResolverImpl
+    : public ServiceResolver,
+      public base::SupportsWeakPtr<ServiceResolverImpl> {
+ public:
+  ServiceResolverImpl(const std::string& service_name,
+                      const ServiceResolver::ResolveCompleteCallback& callback);
+
+  virtual ~ServiceResolverImpl();
+
+  virtual bool StartResolving() OVERRIDE;
+
+  virtual bool IsResolving() const OVERRIDE;
+
+  virtual bool HasResolved() const OVERRIDE;
+
+  virtual std::string GetHumanReadableName() const OVERRIDE;
+  virtual std::string GetType() const OVERRIDE;
+  virtual std::string GetName() const OVERRIDE;
+
+  virtual const Service& GetService() const OVERRIDE;
+
+ private:
+  Service* staging_service() {
+    return &services_[(current_service_index_ + 1) % 2];
+  }
+
+  // Respond to transaction finishing for SRV records.
+  void SrvRecordTransactionResponse(net::MDnsTransaction::Result status,
+                                    const net::RecordParsed* record);
+
+  // Respond to transaction finishing for TXT records.
+  void TxtRecordTransactionResponse(net::MDnsTransaction::Result status,
+                                    const net::RecordParsed* record);
+
+  // Respond to transaction finishing for A records.
+  void ARecordTransactionResponse(net::MDnsTransaction::Result status,
+                                  const net::RecordParsed* record);
+
+  void AlertCallbackIfReady();
+
+  // Convert a TXT record to a vector of strings (metadata).
+  const std::vector<std::string>& RecordToMetadata(
+      const net::RecordParsed* record) const;
+
+  // Convert an SRV record to a host and port pair.
+  net::HostPortPair RecordToAddress(
+      const net::RecordParsed* record) const;
+
+  // Convert an A record to an IP address.
+  const net::IPAddressNumber& RecordToIPAddress(
+      const net::RecordParsed* record) const;
+
+  // Convert an MDns status to a service discovery status.
+  RequestStatus MDnsStatusToRequestStatus(
+      net::MDnsTransaction::Result status) const;
+
+  bool CreateTxtTransaction();
+  bool CreateSrvTransaction();
+  void CreateATransaction();
+
+  std::string service_name_;
+  ResolveCompleteCallback callback_;
+
+  bool is_resolving_;
+  bool has_resolved_;
+
+  bool metadata_resolved_;
+  bool address_resolved_;
+
+  scoped_ptr<net::MDnsTransaction> txt_transaction_;
+  scoped_ptr<net::MDnsTransaction> srv_transaction_;
+  scoped_ptr<net::MDnsTransaction> a_transaction_;
+
+  Service services_[2];
+  int current_service_index_;
+
+  DISALLOW_COPY_AND_ASSIGN(ServiceResolverImpl);
+};
+
+}  // namespace local_discovery
+
+#endif  // CHROME_BROWSER_LOCAL_DISCOVERY_SERVICE_DISCOVERY_CLIENT_IMPL_H_