Non-Local Join for Media Router and Presentation API

chrome/browser/ui/webui/media_router/media_router_ui.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_UI_WEBUI_MEDIA_ROUTER_MEDIA_ROUTER_UI_H_
 #define CHROME_BROWSER_UI_WEBUI_MEDIA_ROUTER_MEDIA_ROUTER_UI_H_
 
 #include <set>
 #include <string>
 #include <vector>
@@ skipping 85 matching lines @@
   // Notifies this instance that the UI has been initialized.
   void UIInitialized();
 
   // Requests a route be created from the source mapped to
   // |cast_mode|, to the sink given by |sink_id|.
   // Returns true if a route request is successfully submitted.
   // |OnRouteResponseReceived()| will be invoked when the route request
   // completes.
   bool CreateRoute(const MediaSink::Id& sink_id, MediaCastMode cast_mode);
 
+  // Calls MediaRouter to join the given route.
+  bool ConnectRemoteRoute(const MediaSink::Id& sink_id,
+                          const MediaRoute::Id& route_id);
+
   // Calls MediaRouter to close the given route.
   void CloseRoute(const MediaRoute::Id& route_id);
 
   // Calls MediaRouter to add the given issue.
   void AddIssue(const Issue& issue);
 
   // Calls MediaRouter to clear the given issue.
   void ClearIssue(const Issue::Id& issue_id);
 
   // Returns the hostname of the default source's parent frame URL.
   std::string GetPresentationRequestSourceName() const;
   std::string GetTruncatedPresentationRequestSourceName() const;
   bool HasPendingRouteRequest() const {
     return current_route_request_id_ != -1;
   }
   const std::vector<MediaSinkWithCastModes>& sinks() const { return sinks_; }
   const std::vector<MediaRoute>& routes() const { return routes_; }
+  const std::vector<MediaRoute::Id>& joinable_route_ids() const {
+    return joinable_route_ids_;
+  }
   const std::set<MediaCastMode>& cast_modes() const { return cast_modes_; }
   const content::WebContents* initiator() const { return initiator_; }
 
   // Marked virtual for tests.
   virtual const std::string& GetRouteProviderExtensionId() const;
 
   // Called to track UI metrics.
   void SetUIInitializationTimer(const base::Time& start_time);
   void OnUIInitiallyLoaded();
   void OnUIInitialDataReceived();
 
  private:
   FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest, SortedSinks);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest,
                            UIMediaRoutesObserverFiltersNonDisplayRoutes);
+  FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest,
+      UIMediaRoutesObserverFiltersNonDisplayJoinableRoutes);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest, GetExtensionNameExtensionPresent);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest,
                            GetExtensionNameEmptyWhenNotInstalled);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest,
                            GetExtensionNameEmptyWhenNotExtensionURL);
 
   class UIIssuesObserver;
+
   class UIMediaRoutesObserver : public MediaRoutesObserver {
    public:
     using RoutesUpdatedCallback =
-        base::Callback<void(const std::vector<MediaRoute>&)>;
+        base::Callback<void(const std::vector<MediaRoute>&,
+            const std::vector<MediaRoute::Id>&)>;
     UIMediaRoutesObserver(MediaRouter* router,
                           const RoutesUpdatedCallback& callback);
+    UIMediaRoutesObserver(MediaRouter* router, const MediaSource::Id& source_id,
+                          const RoutesUpdatedCallback& callback);

[stevenjb, 2016/01/05 20:10:23]

We avoid multiple constructors in Chrome. Either update existing calls to
UIMediaRoutesObserver() or provide a setter for |source_id|.

[matt.boetger, 2016/01/06 22:49:07]

Done.

     ~UIMediaRoutesObserver() override;
 
     // MediaRoutesObserver
-    void OnRoutesUpdated(const std::vector<MediaRoute>& routes) override;
+    void OnRoutesUpdated(
+        const std::vector<MediaRoute>& routes,
+        const std::vector<MediaRoute::Id>& joinable_route_ids) override;
 
    private:
     // Callback to the owning MediaRouterUI instance.
     RoutesUpdatedCallback callback_;
 
     DISALLOW_COPY_AND_ASSIGN(UIMediaRoutesObserver);
   };
 
   static std::string GetExtensionName(const GURL& url,
                                       extensions::ExtensionRegistry* registry);
 
   // QueryResultManager::Observer
   void OnResultsUpdated(
       const std::vector<MediaSinkWithCastModes>& sinks) override;
 
   // Called by |issues_observer_| when the top issue has changed.
   // If the UI is already initialized, notifies |handler_| to update the UI.
   // Ignored if the UI is not yet initialized.
   void SetIssue(const Issue* issue);
 
   // Called by |routes_observer_| when the set of active routes has changed.
-  void OnRoutesUpdated(const std::vector<MediaRoute>& routes);
+  void OnRoutesUpdated(const std::vector<MediaRoute>& routes,
+      const std::vector<MediaRoute::Id>& joinable_route_ids);
 
   // Callback passed to MediaRouter to receive response to route creation
   // requests.
   void OnRouteResponseReceived(const int route_request_id,
                                const MediaSink::Id& sink_id,
                                const MediaRoute* route,
                                const std::string& presentation_id,
                                const std::string& error);
 
   // Creates and sends an issue if route creation times out.
   void RouteCreationTimeout();
 
   // Initializes the dialog with mirroring sources derived from |initiator|.
   void InitCommon(content::WebContents* initiator);
 
   // PresentationServiceDelegateImpl::DefaultPresentationObserver
   void OnDefaultPresentationChanged(
       const PresentationRequest& presentation_request) override;
   void OnDefaultPresentationRemoved() override;
 
+  // Creates a brand new route or, if a |route_id| is supplied, connects to a
+  // non-local route.  This is used for connecting to a non-local route.

[stevenjb, 2016/01/05 20:10:23]

s/  / /

[matt.boetger, 2016/01/06 22:49:07]

Done.

+  // Returns true if a route request is successfully submitted.
+  // |OnRouteResponseReceived()| will be invoked when the route request
+  // completed.

[stevenjb, 2016/01/05 20:10:23]

'completes' or 'is completed'

[matt.boetger, 2016/01/06 22:49:07]

Done.

+  bool CreateOrConnectRoute(const MediaSink::Id& sink_id,
+                            MediaCastMode cast_mode,
+                            const MediaRoute::Id& route_id);
+
   // Updates the set of supported cast modes and sends the updated set to
   // |handler_|.
   void UpdateCastModes();
 
   // Returns the default presentation request's frame URL if there is one.
   // Otherwise returns an empty GURL.
   GURL GetFrameURL() const;
 
   // Owned by the |web_ui| passed in the ctor, and guaranteed to be deleted
   // only after it has deleted |this|.
@@ skipping 15 matching lines @@
   // Sequential counter for route requests. Used to update
   // |current_route_request_id_| when there is a new route request.
   int route_request_counter_;
 
   // Used for locale-aware sorting of sinks by name. Set during |InitCommon()|
   // using the current locale. Set to null
   scoped_ptr<icu::Collator> collator_;
 
   std::vector<MediaSinkWithCastModes> sinks_;
   std::vector<MediaRoute> routes_;
+  std::vector<MediaRoute::Id> joinable_route_ids_;
   CastModeSet cast_modes_;
 
   scoped_ptr<QueryResultManager> query_result_manager_;
 
   // If set, then the result of the next presentation route request will
   // be handled by this object.
   scoped_ptr<CreatePresentationConnectionRequest> create_session_request_;
 
   // Set to the presentation request corresponding to the presentation cast
   // mode, if supported. Otherwise set to nullptr.
@@ skipping 23 matching lines @@
   // NOTE: Weak pointers must be invalidated before all other member variables.
   // Therefore |weak_factory_| must be placed at the end.
   base::WeakPtrFactory<MediaRouterUI> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MediaRouterUI);
 };
 
 }  // namespace media_router
 
 #endif  // CHROME_BROWSER_UI_WEBUI_MEDIA_ROUTER_MEDIA_ROUTER_UI_H_