browser_child_process_host.h revision 5821806d5e7f356e8fa4b058a389a808ea183019 
1// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef CONTENT_PUBLIC_BROWSER_BROWSER_CHILD_PROCESS_HOST_H_
6#define CONTENT_PUBLIC_BROWSER_BROWSER_CHILD_PROCESS_HOST_H_
7
8#include "base/process_util.h"
9#include "base/string16.h"
10#include "build/build_config.h"
11#include "content/common/content_export.h"
12#include "content/public/common/process_type.h"
13#include "ipc/ipc_sender.h"
14
15class CommandLine;
16class FilePath;
17
18namespace content {
19
20class BrowserChildProcessHostDelegate;
21class ChildProcessHost;
22struct ChildProcessData;
23
24// This represents child processes of the browser process, i.e. plugins. They
25// will get terminated at browser shutdown.
26class CONTENT_EXPORT BrowserChildProcessHost : public IPC::Sender {
27 public:
28  // Used to create a child process host. The delegate must outlive this object.
29  static BrowserChildProcessHost* Create(
30      ProcessType type,
31      BrowserChildProcessHostDelegate* delegate);
32
33  virtual ~BrowserChildProcessHost() {}
34
35  // Derived classes call this to launch the child process asynchronously.
36  // Takes ownership of |cmd_line|.
37  virtual void Launch(
38#if defined(OS_WIN)
39      const FilePath& exposed_dir,
40#elif defined(OS_POSIX)
41      bool use_zygote,
42      const base::EnvironmentVector& environ,
43#endif
44      CommandLine* cmd_line) = 0;
45
46  virtual const ChildProcessData& GetData() const = 0;
47
48  // Returns the ChildProcessHost object used by this object.
49  virtual ChildProcessHost* GetHost() const = 0;
50
51  // Returns the termination status of a child.  |exit_code| is the
52  // status returned when the process exited (for posix, as returned
53  // from waitpid(), for Windows, as returned from
54  // GetExitCodeProcess()).  |exit_code| may be NULL.
55  virtual base::TerminationStatus GetTerminationStatus(int* exit_code) = 0;
56
57  // Sets the user-visible name of the process.
58  virtual void SetName(const string16& name) = 0;
59
60  // Set the handle of the process. BrowserChildProcessHost will do this when
61  // the Launch method is used to start the process. However if the owner
62  // of this object doesn't call Launch and starts the process in another way,
63  // they need to call this method so that the process handle is associated with
64  // this object.
65  virtual void SetHandle(base::ProcessHandle handle) = 0;
66
67#if defined(OS_MACOSX) && !defined(OS_IOS)
68  // Returns a PortProvider used to get process metrics for child processes.
69  static base::ProcessMetrics::PortProvider* GetPortProvider();
70#endif
71};
72
73};  // namespace content
74
75#endif  // CONTENT_PUBLIC_BROWSER_BROWSER_CHILD_PROCESS_HOST_H_
76