render_thread.h revision 5c02ac1a9c1b504631c0a3d2b6e737b5d738bae1 
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_RENDERER_RENDER_THREAD_H_
6#define CONTENT_PUBLIC_RENDERER_RENDER_THREAD_H_
7
8#include "base/basictypes.h"
9#include "base/callback.h"
10#include "base/memory/shared_memory.h"
11#include "base/metrics/user_metrics_action.h"
12#include "content/common/content_export.h"
13#include "ipc/ipc_channel_proxy.h"
14#include "ipc/ipc_sender.h"
15
16#if defined(OS_WIN)
17#include <windows.h>
18#endif
19
20class GURL;
21
22namespace base {
23class MessageLoop;
24class MessageLoopProxy;
25class WaitableEvent;
26}
27
28namespace IPC {
29class MessageFilter;
30class SyncChannel;
31class SyncMessageFilter;
32}
33
34namespace v8 {
35class Extension;
36}
37
38namespace content {
39
40class RenderProcessObserver;
41class ResourceDispatcherDelegate;
42
43class CONTENT_EXPORT RenderThread : public IPC::Sender {
44 public:
45  // Returns the one render thread for this process.  Note that this can only
46  // be accessed when running on the render thread itself.
47  static RenderThread* Get();
48
49  RenderThread();
50  virtual ~RenderThread();
51
52  virtual base::MessageLoop* GetMessageLoop() = 0;
53  virtual IPC::SyncChannel* GetChannel() = 0;
54  virtual std::string GetLocale() = 0;
55  virtual IPC::SyncMessageFilter* GetSyncMessageFilter() = 0;
56  virtual scoped_refptr<base::MessageLoopProxy> GetIOMessageLoopProxy() = 0;
57
58  // Called to add or remove a listener for a particular message routing ID.
59  // These methods normally get delegated to a MessageRouter.
60  virtual void AddRoute(int32 routing_id, IPC::Listener* listener) = 0;
61  virtual void RemoveRoute(int32 routing_id) = 0;
62  virtual int GenerateRoutingID() = 0;
63
64  // These map to IPC::ChannelProxy methods.
65  virtual void AddFilter(IPC::MessageFilter* filter) = 0;
66  virtual void RemoveFilter(IPC::MessageFilter* filter) = 0;
67
68  // Add/remove observers for the process.
69  virtual void AddObserver(RenderProcessObserver* observer) = 0;
70  virtual void RemoveObserver(RenderProcessObserver* observer) = 0;
71
72  // Set the ResourceDispatcher delegate object for this process.
73  virtual void SetResourceDispatcherDelegate(
74      ResourceDispatcherDelegate* delegate) = 0;
75
76  // We initialize WebKit as late as possible. Call this to force
77  // initialization.
78  virtual void EnsureWebKitInitialized() = 0;
79
80  // Sends over a base::UserMetricsAction to be recorded by user metrics as
81  // an action. Once a new user metric is added, run
82  //   tools/metrics/actions/extract_actions.py
83  // to add the metric to actions.xml, then update the <owner>s and
84  // <description> sections. Make sure to include the actions.xml file when you
85  // upload your code for review!
86  //
87  // WARNING: When using base::UserMetricsAction, base::UserMetricsAction
88  // and a string literal parameter must be on the same line, e.g.
89  //   RenderThread::Get()->RecordAction(
90  //       base::UserMetricsAction("my extremely long action name"));
91  // because otherwise our processing scripts won't pick up on new actions.
92  virtual void RecordAction(const base::UserMetricsAction& action) = 0;
93
94  // Sends over a string to be recorded by user metrics as a computed action.
95  // When you use this you need to also update the rules for extracting known
96  // actions in chrome/tools/extract_actions.py.
97  virtual void RecordComputedAction(const std::string& action) = 0;
98
99  // Asks the host to create a block of shared memory for the renderer.
100  // The shared memory allocated by the host is returned back.
101  virtual scoped_ptr<base::SharedMemory> HostAllocateSharedMemoryBuffer(
102      size_t buffer_size) = 0;
103
104  // Registers the given V8 extension with WebKit.
105  virtual void RegisterExtension(v8::Extension* extension) = 0;
106
107  // Schedule a call to IdleHandler with the given initial delay.
108  virtual void ScheduleIdleHandler(int64 initial_delay_ms) = 0;
109
110  // A task we invoke periodically to assist with idle cleanup.
111  virtual void IdleHandler() = 0;
112
113  // Get/Set the delay for how often the idle handler is called.
114  virtual int64 GetIdleNotificationDelayInMs() const = 0;
115  virtual void SetIdleNotificationDelayInMs(
116      int64 idle_notification_delay_in_ms) = 0;
117
118  virtual void UpdateHistograms(int sequence_number) = 0;
119
120  // Post task to all worker threads. Returns number of workers.
121  virtual int PostTaskToAllWebWorkers(const base::Closure& closure) = 0;
122
123  // Resolve the proxy servers to use for a given url. On success true is
124  // returned and |proxy_list| is set to a PAC string containing a list of
125  // proxy servers.
126  virtual bool ResolveProxy(const GURL& url, std::string* proxy_list) = 0;
127
128  // Gets the shutdown event for the process.
129  virtual base::WaitableEvent* GetShutdownEvent() = 0;
130
131#if defined(OS_WIN)
132  // Request that the given font be loaded by the browser so it's cached by the
133  // OS. Please see ChildProcessHost::PreCacheFont for details.
134  virtual void PreCacheFont(const LOGFONT& log_font) = 0;
135
136  // Release cached font.
137  virtual void ReleaseCachedFonts() = 0;
138#endif
139};
140
141}  // namespace content
142
143#endif  // CONTENT_PUBLIC_RENDERER_RENDER_THREAD_H_
144