[Presentation API] (alternative) 1-UA: send message between controller and receiver page

content/browser/presentation/presentation_service_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 CONTENT_BROWSER_PRESENTATION_PRESENTATION_SERVICE_IMPL_H_
 #define CONTENT_BROWSER_PRESENTATION_PRESENTATION_SERVICE_IMPL_H_
 
 #include <deque>
 #include <map>
 #include <memory>
+#include <set>
 #include <string>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/compiler_specific.h"
 #include "base/containers/hash_tables.h"
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/linked_ptr.h"
 #include "base/memory/scoped_vector.h"
@@ skipping 20 matching lines @@
 // It handles Presentation API requests coming from Blink / renderer process
 // and delegates the requests to the embedder's media router via
 // PresentationServiceDelegate.
 // An instance of this class tied to a RenderFrameHost and listens to events
 // related to the RFH via implementing WebContentsObserver.
 // This class is instantiated on-demand via Mojo's ConnectToRemoteService
 // from the renderer when the first presentation API request is handled.
 class CONTENT_EXPORT PresentationServiceImpl
     : public NON_EXPORTED_BASE(blink::mojom::PresentationService),
       public WebContentsObserver,
-      public PresentationServiceDelegate::Observer {
+      public PresentationServiceDelegateBase::Observer {
  public:
   using NewSessionCallback =
       base::Callback<void(blink::mojom::PresentationSessionInfoPtr,
                           blink::mojom::PresentationErrorPtr)>;
 
   ~PresentationServiceImpl() override;
 
   // Static factory method to create an instance of PresentationServiceImpl.
   // |render_frame_host|: The RFH the instance is associated with.
   // |request|: The instance will be bound to this request. Used for Mojo setup.
@@ skipping 26 matching lines @@
   FRIEND_TEST_ALL_PREFIXES(PresentationServiceImplTest,
                            ReceiveSessionMessagesAfterReset);
   FRIEND_TEST_ALL_PREFIXES(PresentationServiceImplTest,
                            MaxPendingStartSessionRequests);
   FRIEND_TEST_ALL_PREFIXES(PresentationServiceImplTest,
                            MaxPendingJoinSessionRequests);
   FRIEND_TEST_ALL_PREFIXES(PresentationServiceImplTest,
                            ListenForConnectionStateChange);
   FRIEND_TEST_ALL_PREFIXES(PresentationServiceImplTest,
                            ListenForConnectionClose);
+  FRIEND_TEST_ALL_PREFIXES(PresentationServiceImplTest,
+                           SetPresentationConnection);
+  FRIEND_TEST_ALL_PREFIXES(PresentationServiceImplTest,
+                           ReceiverPresentationServiceDelegate);
 
   // Maximum number of pending JoinSession requests at any given time.
   static const int kMaxNumQueuedSessionRequests = 10;
 
   using SessionMessagesCallback =
       base::Callback<void(mojo::Array<blink::mojom::SessionMessagePtr>)>;
   using SendSessionMessageCallback = base::Callback<void(bool)>;
 
   // Listener implementation owned by PresentationServiceImpl. An instance of
   // this is created when PresentationRequest.getAvailability() is resolved.
@@ skipping 29 matching lines @@
 
    private:
     NewSessionCallback callback_;
 
     DISALLOW_COPY_AND_ASSIGN(NewSessionCallbackWrapper);
   };
 
   // |render_frame_host|: The RFH this instance is associated with.
   // |web_contents|: The WebContents to observe.
   // |delegate|: Where Presentation API requests are delegated to. Not owned
   // by this class.

[imcheng, 2016/11/01 17:20:29]

Please add documentation for |controller_delegate| / |receiver_delegate|

[zhaobin, 2016/11/02 03:55:47]

Done.

   PresentationServiceImpl(
       RenderFrameHost* render_frame_host,
       WebContents* web_contents,
-      PresentationServiceDelegate* delegate);
+      ControllerPresentationServiceDelegate* controller_delegate,
+      ReceiverPresentationServiceDelegate* receiver_delegate);
 
   // PresentationService implementation.
   void SetDefaultPresentationUrls(
       const std::vector<GURL>& presentation_urls) override;
   void SetClient(blink::mojom::PresentationServiceClientPtr client) override;
   void ListenForScreenAvailability(const GURL& url) override;
   void StopListeningForScreenAvailability(const GURL& url) override;
   void StartSession(const std::vector<GURL>& presentation_urls,
                     const NewSessionCallback& callback) override;
   void JoinSession(const std::vector<GURL>& presentation_urls,
                    const base::Optional<std::string>& presentation_id,
                    const NewSessionCallback& callback) override;
   void SendSessionMessage(blink::mojom::PresentationSessionInfoPtr session_info,
                           blink::mojom::SessionMessagePtr session_message,
                           const SendSessionMessageCallback& callback) override;
   void CloseConnection(const GURL& presentation_url,
                        const std::string& presentation_id) override;
   void Terminate(const GURL& presentation_url,
                  const std::string& presentation_id) override;
   void ListenForSessionMessages(
       blink::mojom::PresentationSessionInfoPtr session) override;
+  void SetPresentationConnection(
+      blink::mojom::PresentationSessionInfoPtr session,
+      blink::mojom::PresentationConnectionPtr connection) override;
 
   // Creates a binding between this object and |request|.
   void Bind(mojo::InterfaceRequest<blink::mojom::PresentationService> request);
 
   // WebContentsObserver override.
   void DidNavigateAnyFrame(
       content::RenderFrameHost* render_frame_host,
       const content::LoadCommittedDetails& details,
       const content::FrameNavigateParams& params) override;
   void RenderFrameDeleted(content::RenderFrameHost* render_frame_host) override;
@@ skipping 36 matching lines @@
   void OnJoinSessionError(
       int request_session_id,
       const PresentationError& error);
   void OnSendMessageCallback(bool sent);
 
   // Calls to |delegate_| to start listening for state changes for |connection|.
   // State changes will be returned via |OnConnectionStateChanged|.
   void ListenForConnectionStateChange(
       const PresentationSessionInfo& connection);
 
-  // Passed to embedder's implementation of PresentationServiceDelegate for
-  // later invocation when session messages arrive.
   void OnSessionMessages(
       const content::PresentationSessionInfo& session,
       const ScopedVector<PresentationSessionMessage>& messages,
       bool pass_ownership);
 
+  // A callback registered to OffscreenPresentationManager when
+  // receiver PSImpl inits. Calls |client_| to create a new
+  // PresentationConnection on receiver page.
+  void OnReceiverConnectionAvailable(
+      const content::PresentationSessionInfo& session_info,
+      PresentationConnectionPtr&& controller_connection);
+
   // Associates a JoinSession |callback| with a unique request ID and
   // stores it in a map.
   // Returns a positive value on success.
   int RegisterJoinSessionCallback(const NewSessionCallback& callback);
 
   // Invoked by the embedder's PresentationServiceDelegate when a
   // PresentationConnection's state has changed.
   void OnConnectionStateChanged(
       const PresentationSessionInfo& connection,
       const PresentationConnectionStateChangeInfo& info);
 
   // Returns true if this object is associated with |render_frame_host|.
   bool FrameMatches(content::RenderFrameHost* render_frame_host) const;
 
-  // Embedder-specific delegate to forward Presentation requests to.
-  // May be null if embedder does not support Presentation API.
-  PresentationServiceDelegate* delegate_;
+  PresentationServiceDelegateBase* GetPresentationServiceDelegate();

[imcheng, 2016/11/01 17:20:29]

Please add documentation.

[zhaobin, 2016/11/02 03:55:47]

Done.

+
+  // Embedder-specific delegate for controller to forward Presentation requests
+  // to.
+  // May be null if current page is receiver page or

[imcheng, 2016/11/01 17:20:29]

nit: It is definitely nullptr if either of those are true, isn't it?

[zhaobin, 2016/11/02 03:55:47]

Done.

+  // embedder does not support Presentation API .
+  ControllerPresentationServiceDelegate* controller_delegate_;

[imcheng, 2016/11/01 17:20:29]

* const

[zhaobin, 2016/11/02 03:55:47]

Cannot be const since we set them to nullptr in Reset().

+
+  // Embedder-specific delegate for receiver to forward Presentation requests
+  // to.
+  // May be null if current page is receiver page or

[imcheng, 2016/11/01 17:20:29]

ditto about nullptr

[zhaobin, 2016/11/02 03:55:47]

Done.

+  // embedder does not support Presentation API.
+  ReceiverPresentationServiceDelegate* receiver_delegate_;

[imcheng, 2016/11/01 17:20:29]

* const

[zhaobin, 2016/11/02 03:55:47]

Cannot be const since we set them to nullptr in Reset().

 
   // Proxy to the PresentationServiceClient to send results (e.g., screen
   // availability) to.
   blink::mojom::PresentationServiceClientPtr client_;
 
   std::vector<GURL> default_presentation_urls_;
 
   using ScreenAvailabilityListenerMap =
       std::map<GURL, std::unique_ptr<ScreenAvailabilityListenerImpl>>;
   ScreenAvailabilityListenerMap screen_availability_listeners_;
@@ skipping 22 matching lines @@
 
   // NOTE: Weak pointers must be invalidated before all other member variables.
   base::WeakPtrFactory<PresentationServiceImpl> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(PresentationServiceImpl);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_PRESENTATION_PRESENTATION_SERVICE_IMPL_H_