blob: 011017471e1f86e5d803ea1bdd0ce14b4816d71e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
// 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_BROWSER_H_
#define HEADLESS_PUBLIC_HEADLESS_BROWSER_H_
#include <memory>
#include <string>
#include "base/callback.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "headless/public/headless_export.h"
#include "net/base/host_port_pair.h"
#include "net/base/ip_endpoint.h"
namespace base {
class MessagePump;
class SingleThreadTaskRunner;
}
namespace gfx {
class Size;
}
namespace headless {
class HeadlessWebContents;
// This class represents the global headless browser instance. To get a pointer
// to one, call |HeadlessBrowserMain| to initiate the browser main loop. An
// instance of |HeadlessBrowser| will be passed to the callback given to that
// function.
class HEADLESS_EXPORT HeadlessBrowser {
public:
struct Options;
// Create a new browser tab which navigates to |initial_url|. |size| is in
// physical pixels.
virtual std::unique_ptr<HeadlessWebContents> CreateWebContents(
const GURL& initial_url,
const gfx::Size& size) = 0;
// Returns a task runner for submitting work to the browser main thread.
virtual scoped_refptr<base::SingleThreadTaskRunner> BrowserMainThread()
const = 0;
// Requests browser to stop as soon as possible. |Run| will return as soon as
// browser stops.
virtual void Shutdown() = 0;
protected:
HeadlessBrowser() {}
virtual ~HeadlessBrowser() {}
private:
DISALLOW_COPY_AND_ASSIGN(HeadlessBrowser);
};
// Embedding API overrides for the headless browser.
struct HeadlessBrowser::Options {
Options(const Options& other);
~Options();
class Builder;
// Command line options to be passed to browser.
int argc;
const char** argv;
std::string user_agent;
std::string navigator_platform;
// Address at which DevTools should listen for connections. Disabled by
// default.
net::IPEndPoint devtools_endpoint;
// Address of the HTTP/HTTPS proxy server to use. The system proxy settings
// are used by default.
net::HostPortPair proxy_server;
// Optional message pump that overrides the default. Must outlive the browser.
base::MessagePump* message_pump;
private:
Options(int argc, const char** argv);
};
class HeadlessBrowser::Options::Builder {
public:
Builder(int argc, const char** argv);
Builder();
~Builder();
Builder& SetUserAgent(const std::string& user_agent);
Builder& EnableDevToolsServer(const net::IPEndPoint& endpoint);
Builder& SetMessagePump(base::MessagePump* message_pump);
Builder& SetProxyServer(const net::HostPortPair& proxy_server);
Options Build();
private:
Options options_;
DISALLOW_COPY_AND_ASSIGN(Builder);
};
// Main entry point for running the headless browser. This function constructs
// the headless browser instance, passing it to the given
// |on_browser_start_callback| callback. Note that since this function executes
// the main loop, it will only return after HeadlessBrowser::Shutdown() is
// called, returning the exit code for the process.
int HeadlessBrowserMain(
const HeadlessBrowser::Options& options,
const base::Callback<void(HeadlessBrowser*)>& on_browser_start_callback);
} // namespace headless
#endif // HEADLESS_PUBLIC_HEADLESS_BROWSER_H_
|
