[Presentation API] Handle multiple Presentation URLs in PresentationRequest::getAvailability()

content/renderer/presentation/presentation_dispatcher.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 CONTENT_RENDERER_PRESENTATION_PRESENTATION_DISPATCHER_H_
 #define CONTENT_RENDERER_PRESENTATION_PRESENTATION_DISPATCHER_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
@@ skipping 29 matching lines @@
 // Blink. It forwards the calls to the Mojo PresentationService.
 class CONTENT_EXPORT PresentationDispatcher
     : public RenderFrameObserver,
       public NON_EXPORTED_BASE(blink::WebPresentationClient),
       public NON_EXPORTED_BASE(blink::mojom::PresentationServiceClient) {
  public:
   explicit PresentationDispatcher(RenderFrame* render_frame);
   ~PresentationDispatcher() override;
 
  private:
+  friend class PresentationDispatcherTest;
   struct SendMessageRequest {
     SendMessageRequest(blink::mojom::PresentationSessionInfoPtr session_info,
                        blink::mojom::ConnectionMessagePtr message);
     ~SendMessageRequest();
 
     blink::mojom::PresentationSessionInfoPtr session_info;
     blink::mojom::ConnectionMessagePtr message;
   };
 
   static SendMessageRequest* CreateSendTextMessageRequest(
@@ skipping 27 matching lines @@
                        size_t length) override;
   void sendBlobData(const blink::WebURL& presentationUrl,
                     const blink::WebString& presentationId,
                     const uint8_t* data,
                     size_t length) override;
   void closeSession(const blink::WebURL& presentationUrl,
                     const blink::WebString& presentationId) override;
   void terminateSession(const blink::WebURL& presentationUrl,
                         const blink::WebString& presentationId) override;
   void getAvailability(
-      const blink::WebVector<blink::WebURL>& availabilityUrl,
+      const blink::WebVector<blink::WebURL>& availabilityUrls,
       std::unique_ptr<blink::WebPresentationAvailabilityCallbacks> callbacks)
       override;
   void startListening(blink::WebPresentationAvailabilityObserver*) override;
   void stopListening(blink::WebPresentationAvailabilityObserver*) override;
   void setDefaultPresentationUrls(
       const blink::WebVector<blink::WebURL>& presentationUrls) override;
 
   // RenderFrameObserver implementation.
   void DidCommitProvisionalLoad(
       bool is_new_navigation,
@@ skipping 23 matching lines @@
   void OnReceiverConnectionAvailable(
       blink::mojom::PresentationSessionInfoPtr) override;
 
   // Call to PresentationService to send the message in |request|.
   // |session_info| and |message| of |reuqest| will be consumed.
   // |HandleSendMessageRequests| will be invoked after the send is attempted.
   void DoSendMessage(SendMessageRequest* request);
   void HandleSendMessageRequests(bool success);
 
   void ConnectToPresentationServiceIfNeeded();
+  void SetPresentationServiceForTest(
+      blink::mojom::PresentationServicePtr presentation_service);
 
   void UpdateListeningState();
 
   // Used as a weak reference. Can be null since lifetime is bound to the frame.
   blink::WebPresentationController* controller_;
   blink::WebPresentationReceiver* receiver_;
   blink::mojom::PresentationServicePtr presentation_service_;
   mojo::Binding<blink::mojom::PresentationServiceClient> binding_;
 
   // Message requests are queued here and only one message at a time is sent
   // over mojo channel.
   using MessageRequestQueue = std::queue<std::unique_ptr<SendMessageRequest>>;
   MessageRequestQueue message_request_queue_;
 
   enum class ListeningState {
     INACTIVE,
     WAITING,
     ACTIVE,
   };
 
+  enum class ScreenAvailability {
+    UNKNOWN,
+    AVAILABLE,
+    UNAVAILABLE,
+    UNSUPPORTED
+  };
+
   using AvailabilityCallbacksMap =
       IDMap<std::unique_ptr<blink::WebPresentationAvailabilityCallbacks>>;
   using AvailabilityObserversSet =
       std::set<blink::WebPresentationAvailabilityObserver*>;
 
-  // Tracks status of presentation displays availability for |availability_url|.
+  // Tracks status of presentation displays availability for
+  // |availability_urls|.
   struct AvailabilityStatus {
-    explicit AvailabilityStatus(const GURL& availability_url);
+    AvailabilityStatus(const std::vector<GURL>& availability_urls);
     ~AvailabilityStatus();
 
-    const GURL url;
-    bool last_known_availability;
-    ListeningState listening_state;
+    std::vector<GURL> urls;
     AvailabilityCallbacksMap availability_callbacks;
     AvailabilityObserversSet availability_observers;
   };
 
-  // Map of AvailabilityStatus for known URLs.
-  std::map<GURL, std::unique_ptr<AvailabilityStatus>>
-      availability_status_;
+  // Tracks listening status of |availability_url|.
+  struct ListeningStatus {
+    explicit ListeningStatus(const GURL& availability_url);
+    ~ListeningStatus();
 
-  // Updates the listening state of availability for |status| and notifies the
-  // client.
-  void UpdateListeningState(AvailabilityStatus* status);
+    const GURL url;
+    ScreenAvailability last_known_availability;
+    ListeningState listening_state;
+  };
+
+  // Map of ListeningStatus for known URLs.
+  std::map<GURL, std::unique_ptr<ListeningStatus>> listening_status_;
+
+  // Map of AvailabilityStatus for known PresentationRequest.

[mark a. foltz, 2017/01/11 00:06:03]

s/Map/Set/

[zhaobin, 2017/01/12 03:02:12]

Done.

+  std::set<std::unique_ptr<AvailabilityStatus>> availability_set_;
+
+  // Starts listening to |url|.
+  void StartListening(const GURL& url);
+
+  // Stops listening to |url| if no PresentationAvailability is observing |url|.

[mark a. foltz, 2017/01/11 00:06:02]

Document that StartListening() must have been called first and StopListening
must be called only once per URL.

[zhaobin, 2017/01/12 03:02:12]

Done.

+  void StopListening(const GURL& url);
+
+  ListeningStatus* GetListeningStatus(const GURL& url);

[mark a. foltz, 2017/01/11 00:06:02]

Document that this method returns nullptr if there is no status for |url|.

[zhaobin, 2017/01/12 03:02:12]

Done.

+
+  // Returns AVAILABLE if any url in |urls| has screen availability AVAILABLE;
+  // Returns UNSUPPORTED if any url in |urls| have screen availability
+  // UNSUPPORTED, and no url has screen availability AVAILABLE;
+  // Returns UNAVAILABLE if at least one url in |urls| has screen availability
+  // UNAVAILABLE, and no url has screen availability AVAILABLE or UNSUPPORTED;
+  // Returns UNKNOWN if all urls in |urls| have screen availability
+  // UNKNOWN.
+  PresentationDispatcher::ScreenAvailability GetScreenAvailability(

[mark a. foltz, 2017/01/11 00:06:03]

I don't think you need PresentationDispatcher:: here.

[zhaobin, 2017/01/12 03:02:12]

Done.

+      const std::vector<GURL>& urls);
 
   DISALLOW_COPY_AND_ASSIGN(PresentationDispatcher);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_RENDERER_PRESENTATION_PRESENTATION_DISPATCHER_H_