[Media Router] Custom Controls 2 - add MediaRouter::GetRouteController()

chrome/browser/media/router/mojo/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_MOJO_MEDIA_ROUTER_MOJO_IMPL_H_
 #define CHROME_BROWSER_MEDIA_ROUTER_MOJO_MEDIA_ROUTER_MOJO_IMPL_H_
 
 #include <stdint.h>
 
 #include <deque>
@@ skipping 93 matching lines @@
   void ClearIssue(const Issue::Id& issue_id) override;
   void OnUserGesture() override;
   void SearchSinks(
       const MediaSink::Id& sink_id,
       const MediaSource::Id& source_id,
       const std::string& search_input,
       const std::string& domain,
       const MediaSinkSearchResponseCallback& sink_callback) override;
   void ProvideSinks(const std::string& provider_name,
                     const std::vector<MediaSinkInternal>& sinks) override;
+  scoped_refptr<MediaRouteController> GetRouteController(
+      const MediaRoute::Id& route_id) override;
 
   const std::string& media_route_provider_extension_id() const {
     return media_route_provider_extension_id_;
   }
 
   void set_instance_id_for_test(const std::string& instance_id) {
     instance_id_ = instance_id;
   }
 
  private:
@@ skipping 13 matching lines @@
   FRIEND_TEST_ALL_PREFIXES(
       MediaRouterMojoImplTest,
       RegisterAndUnregisterMediaSinksObserverWithAvailabilityChange);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoImplTest,
                            RegisterAndUnregisterMediaRoutesObserver);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoImplTest,
                            RouteMessagesSingleObserver);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoImplTest,
                            RouteMessagesMultipleObservers);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoImplTest, HandleIssue);
+  FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoImplTest, GetRouteController);
+  FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoImplTest,
+                           GetRouteControllerMultipleTimes);
+  FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoImplTest,
+                           GetRouteControllerAfterInvalidation);
+  FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoImplTest,
+                           GetRouteControllerAfterRouteInvalidation);
+  FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoImplTest,
+                           FailToCreateRouteController);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoExtensionTest,
                            DeferredBindingAndSuspension);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoExtensionTest,
                            DrainPendingRequestQueue);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoExtensionTest,
                            DropOldestPendingRequest);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoExtensionTest,
                            AttemptedWakeupTooManyTimes);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterMojoExtensionTest,
                            WakeupFailedDrainsQueue);
@@ skipping 50 matching lines @@
       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 ID of |extension| in |media_route_provider_extension_id_|.
   void BindToMojoRequest(
       mojo::InterfaceRequest<mojom::MediaRouter> request,
       const extensions::Extension& extension);
 
   // Enqueues a closure for later execution by ExecutePendingRequests().
-  void EnqueueTask(const base::Closure& closure);
+  void EnqueueTask(base::OnceClosure closure);
 
   // Runs a closure if the extension monitored by |extension_monitor_| is
   // active, or defers it for later execution if the extension is suspended.
-  void RunOrDefer(const base::Closure& request);
+  void RunOrDefer(base::OnceClosure request);
 
   // Dispatches the Mojo requests queued in |pending_requests_|.
   void ExecutePendingRequests();
 
   // Drops all pending requests. Called when we have a connection error to
   // component extension and further reattempts are unlikely to help.
   void DrainPendingRequests();
 
   // MediaRouter implementation.
   bool RegisterMediaSinksObserver(MediaSinksObserver* observer) override;
   void UnregisterMediaSinksObserver(MediaSinksObserver* observer) override;
   void RegisterMediaRoutesObserver(MediaRoutesObserver* observer) override;
   void UnregisterMediaRoutesObserver(MediaRoutesObserver* observer) override;
   void RegisterIssuesObserver(IssuesObserver* observer) override;
   void UnregisterIssuesObserver(IssuesObserver* observer) override;
   void RegisterRouteMessageObserver(RouteMessageObserver* observer) override;
   void UnregisterRouteMessageObserver(RouteMessageObserver* observer) override;
+  void DetachRouteController(const MediaRoute::Id& route_id,
+                             MediaRouteController* controller) override;
 
   // Notifies |observer| of any existing cached routes, if it is still
   // registered.
   void NotifyOfExistingRoutesIfRegistered(const MediaSource::Id& source_id,
                                           MediaRoutesObserver* observer) const;
 
   // These calls invoke methods in the component extension via Mojo.
   void DoCreateRoute(const MediaSource::Id& source_id,
                      const MediaSink::Id& sink_id,
                      const url::Origin& origin,
@@ skipping 29 matching lines @@
   void DoStartObservingMediaSinks(const MediaSource::Id& source_id);
   void DoStopObservingMediaSinks(const MediaSource::Id& source_id);
   void DoStartObservingMediaRoutes(const MediaSource::Id& source_id);
   void DoStopObservingMediaRoutes(const MediaSource::Id& source_id);
   void DoSearchSinks(
       const MediaSink::Id& sink_id,
       const MediaSource::Id& source_id,
       const std::string& search_input,
       const std::string& domain,
       const MediaSinkSearchResponseCallback& sink_callback);
+  void DoCreateMediaRouteController(
+      const MediaRoute::Id& route_id,
+      mojom::MediaControllerRequest mojo_media_controller_request,
+      mojom::MediaStatusObserverPtr mojo_observer);
 
   void DoProvideSinks(const std::string& provider_name,
                       const std::vector<MediaSinkInternal>& sinks);
 
   // Error handler callback for |binding_| and |media_route_provider_|.
   void OnConnectionError();
 
   // mojom::MediaRouter implementation.
   void RegisterMediaRouteProvider(
       mojom::MediaRouteProviderPtr media_route_provider_ptr,
@@ skipping 73 matching lines @@
   // happen until the user is clearly interacting with MR.
   void OnFirewallCheckComplete(bool firewall_can_use_local_ports);
 #endif
 
   // Requests MRPM to update media sinks.  This allows MRPs that only do
   // discovery on sink queries an opportunity to update discovery results
   // even if the MRP SinkAvailability is marked UNAVAILABLE.
   void UpdateMediaSinks(const MediaSource::Id& source_id);
   void DoUpdateMediaSinks(const MediaSource::Id& source_id);
 
+  // Invalidates and removes controllers from |route_controllers_| whose media
+  // routes do not appear in |routes|.
+  void RemoveInvalidRouteControllers(const std::vector<MediaRoute>& routes);
+
+  // Callback called by MRP's CreateMediaRouteController().
+  void OnMediaControllerCreated(const MediaRoute::Id& route_id, bool success);
+
   // Pending requests queued to be executed once component extension
   // becomes ready.
-  std::deque<base::Closure> pending_requests_;
+  std::deque<base::OnceClosure> pending_requests_;
 
   std::unordered_map<MediaSource::Id, std::unique_ptr<MediaSinksQuery>>
       sinks_queries_;
 
   std::unordered_map<MediaSource::Id, std::unique_ptr<MediaRoutesQuery>>
       routes_queries_;
 
   std::unordered_map<MediaRoute::Id,
                      std::unique_ptr<base::ObserverList<RouteMessageObserver>>>
       message_observers_;
@@ skipping 30 matching lines @@
   int wakeup_attempt_count_ = 0;
 
   // Records the current reason the extension is being woken up.  Is set to
   // MediaRouteProviderWakeReason::TOTAL_COUNT if there is no pending reason.
   MediaRouteProviderWakeReason current_wake_reason_;
 
   // A flag to ensure that we record the provider version once, during the
   // initial event page wakeup attempt.
   bool provider_version_was_recorded_ = false;
 
+  // Stores route controllers that can be used to send media commands to the
+  // extension.
+  std::unordered_map<MediaRoute::Id, MediaRouteController*> route_controllers_;
+
 #if defined(OS_WIN)
   // A pair of flags to ensure that mDNS discovery is only enabled on Windows
   // when there will be appropriate context for the user to associate a firewall
   // prompt with Media Router. |should_enable_mdns_discovery_| can only go from
   // |false| to |true|. On Windows, |is_mdns_enabled_| is set to |false| in
   // RegisterMediaRouteProvider and only set to |true| when we successfully call
   // the extension to enable mDNS.
   bool is_mdns_enabled_ = false;
   bool should_enable_mdns_discovery_ = false;
 #endif
 
   base::WeakPtrFactory<MediaRouterMojoImpl> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MediaRouterMojoImpl);
 };
 
 }  // namespace media_router
 
 #endif  // CHROME_BROWSER_MEDIA_ROUTER_MOJO_MEDIA_ROUTER_MOJO_IMPL_H_