Non-Local Join for Media Router and Presentation API

chrome/browser/media/router/media_router_mojo_impl.h

 // Copyright 2015 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_MEDIA_ROUTER_MEDIA_ROUTER_MOJO_IMPL_H_
 #define CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTER_MOJO_IMPL_H_
 
 #include <deque>
 #include <map>
 #include <set>
@@ skipping 56 matching lines @@
       const MediaSink::Id& sink_id,
       const GURL& origin,
       content::WebContents* web_contents,
       const std::vector<MediaRouteResponseCallback>& callbacks) override;
   void JoinRoute(
       const MediaSource::Id& source_id,
       const std::string& presentation_id,
       const GURL& origin,
       content::WebContents* web_contents,
       const std::vector<MediaRouteResponseCallback>& callbacks) override;
+  void JoinRouteByRouteId(
+      const MediaSource::Id& source,
+      const MediaRoute::Id& route_id,
+      const GURL& origin,
+      content::WebContents* web_contents,
+      const std::vector<MediaRouteResponseCallback>& callbacks) override;
   void CloseRoute(const MediaRoute::Id& route_id) override;
   void SendRouteMessage(const MediaRoute::Id& route_id,
                         const std::string& message,
                         const SendRouteMessageCallback& callback) override;
   void SendRouteBinaryMessage(
       const MediaRoute::Id& route_id,
       scoped_ptr<std::vector<uint8>> data,
       const SendRouteMessageCallback& callback) override;
   void AddIssue(const Issue& issue) override;
   void ClearIssue(const Issue::Id& issue_id) override;
@@ skipping 42 matching lines @@
   // giving up and draining the pending request queue.
   static const int kMaxWakeupAttemptCount = 3;
 
   class MediaRouterMediaRoutesObserver :
       public media_router::MediaRoutesObserver {
    public:
     explicit MediaRouterMediaRoutesObserver(MediaRouterMojoImpl* router);
     ~MediaRouterMediaRoutesObserver() override;
 
     // media_router::MediaRoutesObserver:
-    void OnRoutesUpdated(const std::vector<media_router::MediaRoute>& routes)
+    void OnRoutesUpdated(
+        const std::vector<media_router::MediaRoute>& routes,
+        const std::vector<media_router::MediaRoute::Id>& joinable_route_ids)
         override;
 
    private:
     MediaRouterMojoImpl* const router_;
 
     DISALLOW_COPY_AND_ASSIGN(MediaRouterMediaRoutesObserver);
   };
 
   // Represents a query to the MRPM for media sinks and holds observers for the
   // query.
   struct MediaSinksQuery {
    public:
     MediaSinksQuery();
     ~MediaSinksQuery();
 
     // True if the query has been sent to the MRPM.  False otherwise.
     bool is_active = false;
     base::ObserverList<MediaSinksObserver> observers;
 
     DISALLOW_COPY_AND_ASSIGN(MediaSinksQuery);
   };
 
+  struct MediaRoutesQuery {
+   public:
+    MediaRoutesQuery();
+    ~MediaRoutesQuery();
+
+    // True if the query has been sent to the MRPM.  False otherwise.
+    bool is_active = false;
+    base::ObserverList<MediaRoutesObserver> observers;
+
+    DISALLOW_COPY_AND_ASSIGN(MediaRoutesQuery);
+  };
+
   // Standard constructor, used by
   // MediaRouterMojoImplFactory::GetApiForBrowserContext.
   explicit MediaRouterMojoImpl(
       extensions::EventPageTracker* event_page_tracker);
 
   // Binds |this| to a Mojo interface request, so that clients can acquire a
   // handle to a MediaRouterMojoImpl instance via the Mojo service connector.
   // Stores the |extension_id| of the component extension.
   void BindToMojoRequest(
       mojo::InterfaceRequest<interfaces::MediaRouter> request,
@@ skipping 45 matching lines @@
                             const std::string& message,
                             const SendRouteMessageCallback& callback);
   void DoSendSessionBinaryMessage(const MediaRoute::Id& route_id,
                                   scoped_ptr<std::vector<uint8>> data,
                                   const SendRouteMessageCallback& callback);
   void DoListenForRouteMessages(const MediaRoute::Id& route_id);
   void DoStopListeningForRouteMessages(const MediaRoute::Id& route_id);
   void DoOnPresentationSessionDetached(const MediaRoute::Id& route_id);
   void DoStartObservingMediaSinks(const MediaSource::Id& source_id);
   void DoStopObservingMediaSinks(const MediaSource::Id& source_id);
-  void DoStartObservingMediaRoutes();
-  void DoStopObservingMediaRoutes();
+  void DoStartObservingMediaRoutes(const MediaSource::Id& source_id);
+  void DoStopObservingMediaRoutes(const MediaSource::Id& source_id);
 
   // Invoked when the next batch of messages arrives.
   // |route_id|: ID of route of the messages.
   // |messages|: A list of messages received.
   // |error|: true if an error occurred.
   void OnRouteMessagesReceived(
       const MediaRoute::Id& route_id,
       mojo::Array<interfaces::RouteMessagePtr> messages,
       bool error);
 
   // Error handler callback for |binding_| and |media_route_provider_|.
   void OnConnectionError();
 
   // interfaces::MediaRouter implementation.
   void RegisterMediaRouteProvider(
       interfaces::MediaRouteProviderPtr media_route_provider_ptr,
       const interfaces::MediaRouter::RegisterMediaRouteProviderCallback&
           callback) override;
   void OnIssue(interfaces::IssuePtr issue) override;
   void OnSinksReceived(const mojo::String& media_source,
                        mojo::Array<interfaces::MediaSinkPtr> sinks) override;
-  void OnRoutesUpdated(mojo::Array<interfaces::MediaRoutePtr> routes) override;
+  void OnRoutesUpdated(const mojo::String& media_source,
+      mojo::Array<interfaces::MediaRoutePtr> routes,
+      mojo::Array<mojo::String> joinable_route_ids) override;
   void OnSinkAvailabilityUpdated(
       interfaces::MediaRouter::SinkAvailability availability) override;
   void OnPresentationConnectionStateChanged(
       const mojo::String& route_id,
       interfaces::MediaRouter::PresentationConnectionState state) override;
 
   // Converts the callback result of calling Mojo CreateRoute()/JoinRoute()
   // into a local callback.
   void RouteResponseReceived(
     const std::string& presentation_id,
@@ skipping 27 matching lines @@
   // Clears the wake reason after the extension has been awoken.
   void ClearWakeReason();
 
   // Pending requests queued to be executed once component extension
   // becomes ready.
   std::deque<base::Closure> pending_requests_;
 
   base::ScopedPtrHashMap<MediaSource::Id, scoped_ptr<MediaSinksQuery>>
       sinks_queries_;
 
+  base::ScopedPtrHashMap<MediaSource::Id, scoped_ptr<MediaRoutesQuery>>

[mark a. foltz, 2015/12/03 19:24:23]

Why do we need this map and |local_routes_observers_|?

[matt.boetger, 2015/12/15 19:21:20]

|local_routes_observers| only deals with local, displayable routes to change
media router icon states.  This list existed before along with a list of
route_observers.  I think refactoring this is outside the scope of this change.

+      routes_queries_;
+
   base::ObserverList<LocalMediaRoutesObserver> local_routes_observers_;
 
-  base::ObserverList<MediaRoutesObserver> routes_observers_;
-
   using PresentationSessionMessagesObserverList =
       base::ObserverList<PresentationSessionMessagesObserver>;
   base::ScopedPtrHashMap<MediaRoute::Id,
                          scoped_ptr<PresentationSessionMessagesObserverList>>
       messages_observers_;
 
   // IDs of MediaRoutes being listened for messages. Note that this is
   // different from |message_observers_| because we might be waiting for
   // |OnRouteMessagesReceived()| to be invoked after all observers for that
   // route have been removed.
@@ skipping 42 matching lines @@
   MediaRouteProviderWakeReason current_wake_reason_;
 
   base::WeakPtrFactory<MediaRouterMojoImpl> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MediaRouterMojoImpl);
 };
 
 }  // namespace media_router
 
 #endif  // CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTER_MOJO_IMPL_H_