[Media Router] Design MediaRouter interface with stub implementation.

chrome/browser/media/router/media_route_provider_manager_host.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_ROUTE_PROVIDER_MANAGER_HOST_H_
+#define CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTE_PROVIDER_MANAGER_HOST_H_
+
+#include <string>
+#include <vector>
+
+#include "base/callback.h"
+#include "chrome/browser/media/router/media_route.h"
+#include "chrome/browser/media/router/media_sink.h"
+#include "chrome/browser/media/router/media_source.h"
+
+namespace media_router {
+
+class MediaRoute;
+
+// An interface acting as the Chrome endpoint for communication between
+// Media Router in Chrome and Media Route Provider Manager (MRPM).
+class MediaRouteProviderManagerHost {
+ public:
+  virtual ~MediaRouteProviderManagerHost() {}
+
+  // Interface for handling responses from the MRPM.
+  class Delegate {
+   public:
+    virtual ~Delegate() {}
+
+    // Called from MediaRouteProviderManagerHost when results from a media
+    // sinks query have been received.
+    // |source|: Media source of the query.
+    // |sinks|: List of sinks compatible with the source.
+    // |routes|: Currently active routes on |sinks|.
+    virtual void OnSinksReceived(const MediaSource& source,
+                                 const std::vector<MediaSink>& sinks) = 0;
+
+    // Called from MediaRouteProviderManagerHost when there is a message from
+    // a route.
+    // |route_id|: The route ID.
+    // |message|: The message.
+    virtual void OnMessage(const MediaRouteId& route_id,
+                           const std::string& message) = 0;
+
+    // Called from MediaRouteProviderManagerHost when a response to a route
+    // request has been received and a route has been established.
+    // |request_id|: ID of original request.
+    // |route|: Description of the established route.
+    virtual void OnRouteResponseReceived(const RouteRequestId& request_id,
+                                         const MediaRoute& route) = 0;
+
+    // Called from MediaRouteProviderManagerHost when an error occurred while
+    // establishing a route.
+    // |request_id|: ID of original request.
+    // |error_text|: Text describing the error.
+    virtual void OnRouteResponseError(const RouteRequestId& request_id,
+                                      const std::string& error_text) = 0;
+
+    // Called from MediaRouteProviderManagerHost when the list of currently
+    // MediaRoutes and their MediaSinks have been updated.
+    // |routes|: List of MediaRoutes.
+    // |sinks|: List of MediaSinks associated with the routes.
+    virtual void OnRoutesUpdated(
+        const std::vector<MediaRoute>& routes,
+        const std::vector<MediaSink>& sinks) = 0;
+
+    // Called when the MRPMHost is being destroyed.
+    virtual void OnHostDestroyed(MediaRouteProviderManagerHost* host) = 0;
+  };
+
+  // The following functions are called from Media Router to MRPM.
+
+  // Instructs MRPM to start a query for compatible media sinks for |source|.
+  // Results from the query and subsequent updates will be received via
+  // |Delegate::OnSinksReceived| until the query is removed from MRPM
+  // via |RemoveMediaSinksQuery|.
+  virtual void AddMediaSinksQuery(const MediaSource& source) = 0;
+
+  // Instructs MRPM to stop a query for compatible media sinks for |source|.
+  virtual void RemoveMediaSinksQuery(const MediaSource& source) = 0;
+
+  // Requests MRPM to establish a route between |source| and a media sink given
+  // by |sink_id|. |request_id| is generated by Media Router and passed
+  // to MRPM to identify the request.
+  virtual void RequestRoute(const RouteRequestId& request_id,
+                            const MediaSource& source,
+                            const MediaSinkId& sink_id) = 0;
+
+  // Requests MRPM to close a route specified by |route_id|.
+  virtual void CloseRoute(const MediaRouteId& route_id) = 0;
+
+  // Requests MRPM to post |message| with optional |extra_info| to a MediaSink
+  // connected by MediaRoute with |route_id|.
+  virtual void PostMessage(const MediaRouteId& route_id,
+                           const std::string& message,
+                           const std::string& extra_info_json) = 0;
+
+  // Requests MRPM to send updates on all MediaRoutes and their MediaSinks.
+  // The updated lists will be received via
+  // |Delegate::OnActiveSinksAndRoutesReceived|.
+  virtual void StartMediaRoutesQuery() = 0;
+
+  // Requests MRPM to stop sending updates on MediaRoutes.
+  virtual void StopMediaRoutesQuery() = 0;
+};
+
+}  // namespace media_router
+
+#endif  // CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTE_PROVIDER_MANAGER_HOST_H_