1/*
2 * Copyright (C) 2015 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#pragma once
27
28#if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
29
30#include "NetworkCache.h"
31#include "NetworkCacheEntry.h"
32#include "NetworkLoadClient.h"
33#include <WebCore/ResourceRequest.h>
34#include <WebCore/ResourceResponse.h>
35#include <WebCore/SharedBuffer.h>
36
37namespace WebKit {
38
39class NetworkLoad;
40
41namespace NetworkCache {
42
43class SpeculativeLoad final : public NetworkLoadClient {
44 WTF_MAKE_FAST_ALLOCATED;
45public:
46 typedef Function<void (std::unique_ptr<NetworkCache::Entry>)> RevalidationCompletionHandler;
47 SpeculativeLoad(Cache&, const GlobalFrameID&, const WebCore::ResourceRequest&, std::unique_ptr<NetworkCache::Entry>, RevalidationCompletionHandler&&);
48
49 virtual ~SpeculativeLoad();
50
51 const WebCore::ResourceRequest& originalRequest() const { return m_originalRequest; }
52
53private:
54 // NetworkLoadClient.
55 void didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent) override { }
56 bool isSynchronous() const override { return false; }
57 bool isAllowedToAskUserForCredentials() const final { return false; }
58 void willSendRedirectedRequest(WebCore::ResourceRequest&&, WebCore::ResourceRequest&& redirectRequest, WebCore::ResourceResponse&& redirectResponse) override;
59 void didReceiveResponse(WebCore::ResourceResponse&&, ResponseCompletionHandler&&) override;
60 void didReceiveBuffer(Ref<WebCore::SharedBuffer>&&, int reportedEncodedDataLength) override;
61 void didFinishLoading(const WebCore::NetworkLoadMetrics&) override;
62 void didFailLoading(const WebCore::ResourceError&) override;
63
64 void didComplete();
65
66 Ref<Cache> m_cache;
67 GlobalFrameID m_globalFrameID;
68 RevalidationCompletionHandler m_completionHandler;
69 WebCore::ResourceRequest m_originalRequest;
70
71 std::unique_ptr<NetworkLoad> m_networkLoad;
72
73 WebCore::ResourceResponse m_response;
74
75 RefPtr<WebCore::SharedBuffer> m_bufferedDataForCache;
76 std::unique_ptr<NetworkCache::Entry> m_cacheEntry;
77 bool m_didComplete { false };
78};
79
80} // namespace NetworkCache
81} // namespace WebKit
82
83#endif // ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
84