OLD | NEW |
---|---|
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ | 5 #ifndef HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ |
6 #define HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ | 6 #define HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ |
7 | 7 |
8 #include <string> | |
9 | |
8 #include "base/callback.h" | 10 #include "base/callback.h" |
9 #include "base/macros.h" | 11 #include "base/macros.h" |
10 #include "base/memory/ref_counted.h" | 12 #include "base/memory/ref_counted.h" |
11 #include "base/memory/scoped_ptr.h" | 13 #include "base/memory/scoped_ptr.h" |
12 #include "headless/public/headless_export.h" | 14 #include "headless/public/headless_export.h" |
15 #include "net/url_request/url_request_context_getter.h" | |
13 | 16 |
14 namespace base { | 17 namespace base { |
18 class MessagePump; | |
15 class SingleThreadTaskRunner; | 19 class SingleThreadTaskRunner; |
16 | |
17 namespace trace_event { | |
18 class TraceConfig; | |
19 } | |
20 } | 20 } |
21 | 21 |
22 namespace gfx { | 22 namespace gfx { |
23 class Size; | 23 class Size; |
24 } | 24 } |
25 | 25 |
26 namespace net { | 26 namespace net { |
27 class URLRequestContextGetter; | 27 class URLRequestContextGetter; |
28 } | 28 } |
29 | 29 |
30 namespace headless { | 30 namespace headless { |
31 class WebContents; | 31 class HeadlessWebContents; |
32 | 32 |
33 // This class represents the global headless browser instance. To get a pointer | |
34 // to one, call |HeadlessBrowserMain| to initiate the browser main loop. An | |
35 // instance of |HeadlessBrowser| will be passed to the callback given to that | |
36 // function. | |
33 class HEADLESS_EXPORT HeadlessBrowser { | 37 class HEADLESS_EXPORT HeadlessBrowser { |
34 public: | 38 public: |
35 static HeadlessBrowser* Get(); | |
36 | |
37 struct Options; | 39 struct Options; |
38 | 40 |
39 // Main routine for running browser. | 41 // Create a new browser tab. |size| is in physical pixels. |
40 // Takes command line args and callback to run as soon as browser starts. | 42 virtual scoped_ptr<HeadlessWebContents> CreateWebContents( |
41 static int Run( | 43 const gfx::Size& size) = 0; |
42 const Options& options, | |
43 const base::Callback<void(HeadlessBrowser*)>& on_browser_start_callback); | |
44 | 44 |
45 // Create a new browser tab. | 45 // Returns a task runner for submitting work to the browser main thread. |
46 virtual scoped_ptr<WebContents> CreateWebContents(const gfx::Size& size) = 0; | 46 virtual scoped_refptr<base::SingleThreadTaskRunner> BrowserMainThread() |
47 const = 0; | |
47 | 48 |
48 virtual scoped_refptr<base::SingleThreadTaskRunner> BrowserMainThread() = 0; | 49 // Requests browser to stop as soon as possible. |Run| will return as soon as |
49 virtual scoped_refptr<base::SingleThreadTaskRunner> RendererMainThread() = 0; | 50 // browser stops. |
50 | 51 virtual void Shutdown() = 0; |
51 // Requests browser to stop as soon as possible. | |
52 // |Run| will return as soon as browser stops. | |
53 virtual void Stop() = 0; | |
54 | |
55 virtual void StartTracing(const base::trace_event::TraceConfig& trace_config, | |
56 const base::Closure& on_tracing_started) = 0; | |
57 virtual void StopTracing(const std::string& log_file_name, | |
58 const base::Closure& on_tracing_stopped) = 0; | |
59 | 52 |
60 protected: | 53 protected: |
54 HeadlessBrowser() {} | |
61 virtual ~HeadlessBrowser() {} | 55 virtual ~HeadlessBrowser() {} |
62 | 56 |
63 private: | 57 private: |
64 DISALLOW_COPY_AND_ASSIGN(HeadlessBrowser); | 58 DISALLOW_COPY_AND_ASSIGN(HeadlessBrowser); |
65 }; | 59 }; |
66 | 60 |
61 // Embedding API overrides for the headless browser. | |
67 struct HeadlessBrowser::Options { | 62 struct HeadlessBrowser::Options { |
68 ~Options(); | 63 ~Options(); |
69 | 64 |
70 class Builder; | 65 class Builder; |
71 | 66 |
72 // Command line options to be passed to browser. | 67 // Command line options to be passed to browser. |
73 int argc; | 68 int argc; |
74 const char** argv; | 69 const char** argv; |
75 | 70 |
76 std::string user_agent; | 71 std::string user_agent; |
77 std::string navigator_platform; | 72 std::string navigator_platform; |
78 | 73 |
79 static const int kInvalidPort = -1; | 74 static const int kInvalidPort = -1; |
80 // If not null, create start devtools for remote debugging | 75 std::string devtools_http_address; |
81 // on specified port. | |
82 int devtools_http_port; | 76 int devtools_http_port; |
83 | 77 |
84 // Optional URLRequestContextGetter for customizing network stack. | 78 // Optional message pump that overrides the default. Must outlive the browser. |
85 // Allows overriding: | 79 base::MessagePump* message_pump; |
86 // - Cookie storage | |
87 // - HTTP cache | |
88 // - SSL config | |
89 // - Proxy service | |
90 scoped_refptr<net::URLRequestContextGetter> url_request_context_getter; | |
91 | |
92 scoped_ptr<base::MessagePump> message_pump; | |
93 | 80 |
94 private: | 81 private: |
95 Options(int argc, const char** argv); | 82 Options(int argc, const char** argv); |
96 }; | 83 }; |
97 | 84 |
98 class HeadlessBrowser::Options::Builder { | 85 class HeadlessBrowser::Options::Builder { |
99 public: | 86 public: |
100 Builder(int argc, const char** argv); | 87 Builder(int argc, const char** argv); |
101 ~Builder(); | 88 ~Builder(); |
102 | 89 |
103 Builder& SetUserAgent(const std::string& user_agent); | 90 Builder& SetUserAgent(const std::string& user_agent); |
104 Builder& EnableDevToolsServer(int port); | 91 Builder& EnableDevToolsServer(const std::string& address, int port); |
Ryan Sleevi
2016/02/25 22:04:37
IPEndPoint? :)
Sami
2016/02/26 18:49:16
Done.
| |
105 Builder& SetURLRequestContextGetter( | 92 Builder& SetMessagePump(base::MessagePump* message_pump); |
106 scoped_refptr<net::URLRequestContextGetter> url_request_context_getter); | |
107 | 93 |
108 Options Build(); | 94 Options Build(); |
109 | 95 |
110 private: | 96 private: |
111 Options options_; | 97 Options options_; |
112 | 98 |
113 DISALLOW_COPY_AND_ASSIGN(Builder); | 99 DISALLOW_COPY_AND_ASSIGN(Builder); |
114 }; | 100 }; |
115 | 101 |
102 // Main entry point for running the headless browser. This function constructs | |
103 // the headless browser instance, passing it to the given | |
104 // |on_browser_start_callback| callback. Note that since this function executes | |
105 // the main loop, it will only return after HeadlessBrowser::Shutdown() is | |
106 // called, returning the exit code for the process. | |
107 int HeadlessBrowserMain( | |
108 const HeadlessBrowser::Options& options, | |
109 const base::Callback<void(HeadlessBrowser*)>& on_browser_start_callback); | |
110 | |
116 } // namespace headless | 111 } // namespace headless |
117 | 112 |
118 #endif // HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ | 113 #endif // HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ |
OLD | NEW |