Add HeadlessTabSocket

headless/public/headless_web_contents.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 HEADLESS_PUBLIC_HEADLESS_WEB_CONTENTS_H_
 #define HEADLESS_PUBLIC_HEADLESS_WEB_CONTENTS_H_
 
 #include <list>
 #include <string>
 #include <utility>
 
 #include "base/callback.h"
 #include "base/macros.h"
 #include "base/process/kill.h"
 #include "headless/public/headless_export.h"
 #include "mojo/public/cpp/bindings/interface_request.h"
 #include "ui/gfx/geometry/size.h"
 #include "url/gurl.h"
 
 namespace headless {
 class HeadlessBrowserContextImpl;
 class HeadlessBrowserImpl;
 class HeadlessDevToolsTarget;
+class HeadlessTabSocket;
 
 // Class representing contents of a browser tab. Should be accessed from browser
 // main thread.
 class HEADLESS_EXPORT HeadlessWebContents {
  public:
   class HEADLESS_EXPORT Builder;
 
   virtual ~HeadlessWebContents() {}
 
   class HEADLESS_EXPORT Observer {
@@ skipping 30 matching lines @@
   virtual void RemoveObserver(Observer* observer) = 0;
 
   // Return a DevTools target corresponding to this tab. Note that this method
   // won't return a valid value until Observer::DevToolsTargetReady has been
   // signaled.
   virtual HeadlessDevToolsTarget* GetDevToolsTarget() = 0;
 
   // Close this page. |HeadlessWebContents| object will be destroyed.
   virtual void Close() = 0;
 
+  // Returns the headless tab socket for JS -> C++ if one was created.
+  virtual HeadlessTabSocket* GetHeadlessTabSocket() const = 0;
+
  private:
   friend class HeadlessWebContentsImpl;
   HeadlessWebContents() {}
 
   DISALLOW_COPY_AND_ASSIGN(HeadlessWebContents);
 };
 
 class HEADLESS_EXPORT HeadlessWebContents::Builder {
  public:
   ~Builder();
   Builder(Builder&&);
 
   // Set an initial URL to ensure that the renderer gets initialized and
   // eventually becomes ready to be inspected. See
   // HeadlessWebContents::Observer::DevToolsTargetReady. The default URL is
   // about:blank.
   Builder& SetInitialURL(const GURL& initial_url);
 
   // Specify the initial window size (default is configured in browser options).
   Builder& SetWindowSize(const gfx::Size& size);
 
   // Specify an embedder provided Mojo service to be installed.  The
   // |service_factory| callback is called on demand by Mojo to instantiate the
   // service if a client asks for it.
+  // TODO(alexclarke): Remove AddMojoService.

[Sami, 2017/04/12 14:18:46]

Please also mention that this is deprecated.

[alex clarke (OOO till 29th), 2017/04/12 15:47:46]

Done.

   template <typename Interface>
   Builder& AddMojoService(
       const base::Callback<void(mojo::InterfaceRequest<Interface>)>&
           service_factory) {
     return AddMojoService(
         Interface::Name_,
         base::Bind(&Builder::ForwardToServiceFactory<Interface>,
                    service_factory));
   }
   Builder& AddMojoService(const std::string& service_name,
                           const base::Callback<void(
                               mojo::ScopedMessagePipeHandle)>& service_factory);
 
+  // Whether or not a headless tab socket should be created, to allow JS -> C++
+  // embedder communications.
+  Builder& CreateTabSocket(bool create_tab_socket);
+
   // The returned object is owned by HeadlessBrowser. Call
   // HeadlessWebContents::Close() to dispose it.
   HeadlessWebContents* Build();
 
  private:
   friend class HeadlessBrowserImpl;
   friend class HeadlessBrowserContextImpl;
   friend class HeadlessWebContentsImpl;
 
   explicit Builder(HeadlessBrowserContextImpl* browser_context);
@@ skipping 18 matching lines @@
 
    private:
     DISALLOW_COPY_AND_ASSIGN(MojoService);
   };
 
   HeadlessBrowserContextImpl* browser_context_;
 
   GURL initial_url_ = GURL("about:blank");
   gfx::Size window_size_;
   std::list<MojoService> mojo_services_;
+  bool create_tab_socket_ = false;
 
   DISALLOW_COPY_AND_ASSIGN(Builder);
 };
 
 }  // namespace headless
 
 #endif  // HEADLESS_PUBLIC_HEADLESS_WEB_CONTENTS_H_