[Media Router] Wiring for searching route providers for new sinks.

chrome/browser/media/router/media_router.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_H_
 #define CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTER_H_
 
 #include <stdint.h>
 
 #include <string>
@@ skipping 25 matching lines @@
 class PresentationConnectionStateObserver;
 class PresentationSessionMessagesObserver;
 class RouteRequestResult;
 
 // Type of callback used in |CreateRoute()|, |JoinRoute()|, and
 // |ConnectRouteByRouteId()|. Callback is invoked when the route request either
 // succeeded or failed.
 using MediaRouteResponseCallback =
     base::Callback<void(const RouteRequestResult& result)>;
 
+// Type of callback used for |SearchSinksAndCreateRoute()| to return the sink ID
+// of the newly-found sink. The sink ID will be the empty string if no sink was
+// found.
+using MediaSinkSearchResponseCallback =
+    base::Callback<void(const std::string& sink_id)>;
+
 // Subscription object returned by calling
 // |AddPresentationConnectionStateChangedCallback|. See the method comments for
 // details.
 using PresentationConnectionStateSubscription = base::CallbackList<void(
     const content::PresentationConnectionStateChangeInfo&)>::Subscription;
 
 // An interface for handling resources related to media routing.
 // Responsible for registering observers for receiving sink availability
 // updates, handling route requests/responses, and operating on routes (e.g.
 // posting messages or closing).
@@ skipping 96 matching lines @@
   virtual void AddIssue(const Issue& issue) = 0;
 
   // Clears the issue with the id |issue_id|.
   virtual void ClearIssue(const Issue::Id& issue_id) = 0;
 
   // Notifies the Media Router that the user has taken an action involving the
   // Media Router. This can be used to perform any initialization that is not
   // approriate to be done at construction.
   virtual void OnUserGesture() = 0;
 
+  // Sends a SearchSinks request to the MRPM using the given criteria.

[imcheng, 2016/04/18 23:15:46]

nit on comment: MRPM is a detail of the mojo implementation of MediaRouter. I
would word it as "Searches for a MediaSink using |search_input| and |domain| as
criteria. Also please document the additional behavior of a route being created.

[btolsch, 2016/04/19 01:39:42]

Done.

+  virtual void SearchSinksAndCreateRoute(
+      const MediaSource::Id& source_id,
+      const MediaSink::Id& sink_id,
+      const std::string& search_input,
+      const std::string& domain,
+      const GURL& origin,
+      content::WebContents* web_contents,
+      const std::vector<MediaRouteResponseCallback>& route_callbacks,
+      const MediaSinkSearchResponseCallback& sink_callback,
+      base::TimeDelta timeout,
+      bool off_the_record) = 0;
+
   // Adds |callback| to listen for state changes for presentation connected to
   // |route_id|. The returned Subscription object is owned by the caller.
   // |callback| will be invoked whenever there are state changes, until the
   // caller destroys the Subscription object.
   virtual scoped_ptr<PresentationConnectionStateSubscription>
   AddPresentationConnectionStateChangedCallback(
       const MediaRoute::Id& route_id,
       const content::PresentationConnectionStateChangedCallback& callback) = 0;
 
   // Called when the off the record (incognito) profile for this instance is
@@ skipping 58 matching lines @@
 
   // Unregisters a previously registered PresentationSessionMessagesObserver.
   // |observer| will stop receiving further updates.
   virtual void UnregisterPresentationSessionMessagesObserver(
       PresentationSessionMessagesObserver* observer) = 0;
 };
 
 }  // namespace media_router
 
 #endif  // CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTER_H_