Add types for DownloadID and TaskIdentifier
[WebKit-https.git] / Source / WebKit2 / Shared / Downloads / DownloadManager.h
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef DownloadManager_h
27 #define DownloadManager_h
28
29 #include "Download.h"
30 #include "SandboxExtension.h"
31 #include <WebCore/NotImplemented.h>
32 #include <wtf/Forward.h>
33 #include <wtf/HashMap.h>
34 #include <wtf/Noncopyable.h>
35
36 namespace WebCore {
37 #if !USE(NETWORK_SESSION)
38 class ResourceHandle;
39 #endif
40 class ResourceRequest;
41 class ResourceResponse;
42 class SessionID;
43 }
44
45 namespace IPC {
46 class Connection;
47 class DataReference;
48 }
49
50 namespace WebKit {
51
52 class AuthenticationManager;
53 class Download;
54 class NetworkDataTask;
55 class WebPage;
56
57 class DownloadManager {
58     WTF_MAKE_NONCOPYABLE(DownloadManager);
59
60 public:
61     class Client {
62     public:
63         virtual ~Client() { }
64
65         virtual void didCreateDownload() = 0;
66         virtual void didDestroyDownload() = 0;
67         virtual IPC::Connection* downloadProxyConnection() = 0;
68         virtual AuthenticationManager& downloadsAuthenticationManager() = 0;
69     };
70
71     explicit DownloadManager(Client*);
72
73     void startDownload(WebCore::SessionID, DownloadID, const WebCore::ResourceRequest&);
74 #if !USE(NETWORK_SESSION)
75     void convertHandleToDownload(DownloadID, WebCore::ResourceHandle*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&);
76 #endif
77
78     void resumeDownload(WebCore::SessionID, DownloadID, const IPC::DataReference& resumeData, const String& path, const SandboxExtension::Handle&);
79
80     void cancelDownload(DownloadID);
81
82     void downloadFinished(Download*);
83     bool isDownloading() const { return !m_downloads.isEmpty(); }
84     uint64_t activeDownloadCount() const { return m_downloads.size(); }
85
86     void didCreateDownload();
87     void didDestroyDownload();
88
89     IPC::Connection* downloadProxyConnection();
90     AuthenticationManager& downloadsAuthenticationManager();
91
92 private:
93     Client* m_client;
94     HashMap<DownloadID, std::unique_ptr<Download>> m_downloads;
95 };
96
97 } // namespace WebKit
98
99 #endif // DownloadManager_h