Home | History | Annotate | Download | only in browser 
      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_UTILITY_PROCESS_HOST_H_
      6 #define CONTENT_PUBLIC_BROWSER_UTILITY_PROCESS_HOST_H_
      7 
      8 #include "base/environment.h"
      9 #include "base/process/launch.h"
     10 #include "base/threading/thread.h"
     11 #include "content/common/content_export.h"
     12 #include "ipc/ipc_sender.h"
     13 
     14 namespace base {
     15 class FilePath;
     16 class SequencedTaskRunner;
     17 }
     18 
     19 namespace content {
     20 class UtilityProcessHostClient;
     21 struct ChildProcessData;
     22 
     23 // This class acts as the browser-side host to a utility child process.  A
     24 // utility process is a short-lived process that is created to run a specific
     25 // task.  This class lives solely on the IO thread.
     26 // If you need a single method call in the process, use StartFooBar(p).
     27 // If you need multiple batches of work to be done in the process, use
     28 // StartBatchMode(), then multiple calls to StartFooBar(p), then finish with
     29 // EndBatchMode().
     30 //
     31 // Note: If your class keeps a ptr to an object of this type, grab a weak ptr to
     32 // avoid a use after free since this object is deleted synchronously but the
     33 // client notification is asynchronous.  See http://crbug.com/108871.
     34 class UtilityProcessHost : public IPC::Sender,
     35                            public base::SupportsWeakPtr<UtilityProcessHost> {
     36  public:
     37   // Used to create a utility process. |client| is optional. If supplied it will
     38   // be notified of incoming messages from the utility process.
     39   // |client_task_runner| is required if |client| is supplied and is the task
     40   // runner upon which |client| will be invoked.
     41   CONTENT_EXPORT static UtilityProcessHost* Create(
     42       const scoped_refptr<UtilityProcessHostClient>& client,
     43       const scoped_refptr<base::SequencedTaskRunner>& client_task_runner);
     44 
     45   virtual ~UtilityProcessHost() {}
     46 
     47   // Starts utility process in batch mode. Caller must call EndBatchMode()
     48   // to finish the utility process.
     49   virtual bool StartBatchMode() = 0;
     50 
     51   // Ends the utility process. Must be called after StartBatchMode().
     52   virtual void EndBatchMode() = 0;
     53 
     54   // Allows a directory to be opened through the sandbox, in case it's needed by
     55   // the operation.
     56   virtual void SetExposedDir(const base::FilePath& dir) = 0;
     57 
     58   // Perform presandbox initialization for mDNS.
     59   virtual void EnableMDns() = 0;
     60 
     61   // Make the process run without a sandbox.
     62   virtual void DisableSandbox() = 0;
     63 
     64 #if defined(OS_WIN)
     65   // Make the process run elevated.
     66   virtual void ElevatePrivileges() = 0;
     67 #endif
     68 
     69   // Returns information about the utility child process.
     70   virtual const ChildProcessData& GetData() = 0;
     71 
     72 #if defined(OS_POSIX)
     73   virtual void SetEnv(const base::EnvironmentMap& env) = 0;
     74 #endif
     75 };
     76 
     77 };  // namespace content
     78 
     79 #endif  // CONTENT_PUBLIC_BROWSER_UTILITY_PROCESS_HOST_H_
     80