Re-subimission of https://codereview.chromium.org/1041213003/
[chromium-blink-merge.git] / content / browser / download / download_request_handle.h
blob76affae249e5a5b41a4e4940c5bfffe0de932bdd
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.
5 #ifndef CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_REQUEST_HANDLE_H_
6 #define CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_REQUEST_HANDLE_H_
8 #include <string>
10 #include "base/compiler_specific.h"
11 #include "base/memory/weak_ptr.h"
12 #include "content/browser/download/download_resource_handler.h"
13 #include "content/common/content_export.h"
15 namespace content {
16 class DownloadManager;
17 class WebContents;
19 // A handle used by the download system for operations on the URLRequest
20 // or objects conditional on it (e.g. WebContentsImpl).
21 // This class needs to be copyable, so we can pass it across threads and not
22 // worry about lifetime or const-ness.
24 // DownloadRequestHandleInterface is defined for mocking purposes.
25 class CONTENT_EXPORT DownloadRequestHandleInterface {
26 public:
27 virtual ~DownloadRequestHandleInterface() {}
29 // These functions must be called on the UI thread.
30 virtual WebContents* GetWebContents() const = 0;
31 virtual DownloadManager* GetDownloadManager() const = 0;
33 // Pauses or resumes the matching URL request.
34 virtual void PauseRequest() const = 0;
35 virtual void ResumeRequest() const = 0;
37 // Cancels the request.
38 virtual void CancelRequest() const = 0;
40 // Describes the object.
41 virtual std::string DebugString() const = 0;
45 class CONTENT_EXPORT DownloadRequestHandle
46 : public DownloadRequestHandleInterface {
47 public:
48 ~DownloadRequestHandle() override;
50 // Create a null DownloadRequestHandle: getters will return null, and
51 // all actions are no-ops.
52 // TODO(rdsmith): Ideally, actions would be forbidden rather than
53 // no-ops, to confirm that no non-testing code actually uses
54 // a null DownloadRequestHandle. But for now, we need the no-op
55 // behavior for unit tests. Long-term, this should be fixed by
56 // allowing mocking of ResourceDispatcherHost in unit tests.
57 DownloadRequestHandle();
59 // Note that |rdh| is required to be non-null.
60 DownloadRequestHandle(const base::WeakPtr<DownloadResourceHandler>& handler,
61 int child_id,
62 int render_view_id,
63 int request_id);
65 // Implement DownloadRequestHandleInterface interface.
66 WebContents* GetWebContents() const override;
67 DownloadManager* GetDownloadManager() const override;
68 void PauseRequest() const override;
69 void ResumeRequest() const override;
70 void CancelRequest() const override;
71 std::string DebugString() const override;
73 private:
74 base::WeakPtr<DownloadResourceHandler> handler_;
76 // The ID of the child process that started the download.
77 int child_id_;
79 // The ID of the render view that started the download.
80 int render_view_id_;
82 // The ID associated with the request used for the download.
83 int request_id_;
86 } // namespace content
88 #endif // CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_REQUEST_HANDLE_H_