Move loading responsibility out of WebResourceLoadScheduler into a new WebResourceLoader
[WebKit-https.git] / Source / WebKit2 / NetworkProcess / NetworkResourceLoader.h
1 /*
2  * Copyright (C) 2012 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 NetworkResourceLoader_h
27 #define NetworkResourceLoader_h
28
29 #if ENABLE(NETWORK_PROCESS)
30
31 #include "MessageSender.h"
32 #include "NetworkConnectionToWebProcess.h"
33 #include "NetworkResourceLoadParameters.h"
34 #include <WebCore/ResourceHandleClient.h>
35 #include <WebCore/ResourceLoaderOptions.h>
36 #include <WebCore/ResourceRequest.h>
37
38 namespace WebCore {
39 class ResourceBuffer;
40 class ResourceHandle;
41 }
42
43 namespace WebKit {
44
45 class RemoteNetworkingContext;
46 typedef uint64_t ResourceLoadIdentifier;
47
48 class NetworkResourceLoader : public RefCounted<NetworkResourceLoader>, public NetworkConnectionToWebProcessObserver, public WebCore::ResourceHandleClient, public CoreIPC::MessageSender<NetworkResourceLoader> {
49 public:
50     static RefPtr<NetworkResourceLoader> create(const NetworkResourceLoadParameters& parameters, ResourceLoadIdentifier identifier, NetworkConnectionToWebProcess* connection)
51     {
52         return adoptRef(new NetworkResourceLoader(parameters, identifier, connection));
53     }
54     
55     ~NetworkResourceLoader();
56
57     // Used by MessageSender.
58     CoreIPC::Connection* connection() const;
59     uint64_t destinationID() const { return identifier(); }
60     
61     void start();
62
63     virtual void connectionToWebProcessDidClose(NetworkConnectionToWebProcess*) OVERRIDE;
64     
65     ResourceLoadIdentifier identifier() const { return m_identifier; }
66     WebCore::ResourceLoadPriority priority() const;
67     
68     NetworkConnectionToWebProcess* connectionToWebProcess() { return m_connection.get(); }
69
70     // ResourceHandleClient methods
71     virtual void willSendRequest(WebCore::ResourceHandle*, WebCore::ResourceRequest&, const WebCore::ResourceResponse& /*redirectResponse*/) OVERRIDE;
72     virtual void didSendData(WebCore::ResourceHandle*, unsigned long long /*bytesSent*/, unsigned long long /*totalBytesToBeSent*/) OVERRIDE;
73     virtual void didReceiveResponse(WebCore::ResourceHandle*, const WebCore::ResourceResponse&) OVERRIDE;
74     virtual void didReceiveData(WebCore::ResourceHandle*, const char*, int, int /*encodedDataLength*/) OVERRIDE;
75     virtual void didReceiveCachedMetadata(WebCore::ResourceHandle*, const char*, int) OVERRIDE;
76     virtual void didFinishLoading(WebCore::ResourceHandle*, double /*finishTime*/) OVERRIDE;
77     virtual void didFail(WebCore::ResourceHandle*, const WebCore::ResourceError&) OVERRIDE;
78     virtual void wasBlocked(WebCore::ResourceHandle*) OVERRIDE;
79     virtual void cannotShowURL(WebCore::ResourceHandle*) OVERRIDE;
80     virtual void willCacheResponse(WebCore::ResourceHandle*, WebCore::CacheStoragePolicy&) OVERRIDE;
81     virtual bool shouldUseCredentialStorage(WebCore::ResourceHandle*) OVERRIDE;
82     virtual void didReceiveAuthenticationChallenge(WebCore::ResourceHandle*, const WebCore::AuthenticationChallenge&) OVERRIDE;
83     virtual void didCancelAuthenticationChallenge(WebCore::ResourceHandle*, const WebCore::AuthenticationChallenge&) OVERRIDE;
84     virtual void receivedCancellation(WebCore::ResourceHandle*, const WebCore::AuthenticationChallenge&) OVERRIDE;
85
86 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
87     virtual bool canAuthenticateAgainstProtectionSpace(WebCore::ResourceHandle*, const WebCore::ProtectionSpace&) OVERRIDE;
88 #endif
89
90 #if HAVE(NETWORK_CFDATA_ARRAY_CALLBACK)
91     virtual bool supportsDataArray() OVERRIDE;
92     virtual void didReceiveDataArray(WebCore::ResourceHandle*, CFArrayRef) OVERRIDE;
93 #endif
94
95 #if PLATFORM(MAC)
96 #if USE(CFNETWORK)
97     virtual CFCachedURLResponseRef willCacheResponse(WebCore::ResourceHandle*, CFCachedURLResponseRef) OVERRIDE;
98 #else
99     virtual NSCachedURLResponse* willCacheResponse(WebCore::ResourceHandle*, NSCachedURLResponse*) OVERRIDE;
100 #endif
101     virtual void willStopBufferingData(WebCore::ResourceHandle*, const char*, int) OVERRIDE;
102 #endif // PLATFORM(MAC)
103
104 #if ENABLE(BLOB)
105     virtual WebCore::AsyncFileStream* createAsyncFileStream(WebCore::FileStreamClient*) OVERRIDE;
106 #endif
107
108 private:
109     NetworkResourceLoader(const NetworkResourceLoadParameters&, ResourceLoadIdentifier, NetworkConnectionToWebProcess*);
110
111     void scheduleStopOnMainThread();
112     static void performStops(void*);
113
114     void stop();
115
116     NetworkResourceLoadParameters m_requestParameters;
117     ResourceLoadIdentifier m_identifier;
118
119     RefPtr<RemoteNetworkingContext> m_networkingContext;
120     RefPtr<WebCore::ResourceHandle> m_handle;    
121     RefPtr<NetworkConnectionToWebProcess> m_connection;
122 };
123
124 void didReceiveWillSendRequestHandled(uint64_t requestID, const WebCore::ResourceRequest&);
125
126 } // namespace WebKit
127
128 #endif // ENABLE(NETWORK_PROCESS)
129
130 #endif // NetworkResourceLoader_h