File: ResourceLoader.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (136 lines) | stat: -rw-r--r-- 5,385 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
 * Copyright (C) 2005, 2006, 2011 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ResourceLoader_h
#define ResourceLoader_h

#include "core/CoreExport.h"
#include "core/fetch/ResourceLoaderOptions.h"
#include "platform/network/ResourceRequest.h"
#include "public/platform/WebURLLoader.h"
#include "public/platform/WebURLLoaderClient.h"
#include "wtf/Forward.h"
#include <memory>

namespace blink {

class FetchContext;
class Resource;
class ResourceError;
class ResourceFetcher;

// A ResourceLoader is created for each Resource by the ResourceFetcher when it
// needs to load the specified resource. A ResourceLoader creates a
// WebURLLoader and loads the resource using it. Any per-load logic should be
// implemented in this class basically.
class CORE_EXPORT ResourceLoader final
    : public GarbageCollectedFinalized<ResourceLoader>,
      protected WebURLLoaderClient {
  USING_PRE_FINALIZER(ResourceLoader, dispose);

 public:
  static ResourceLoader* create(ResourceFetcher*, Resource*);
  ~ResourceLoader() override;
  DECLARE_TRACE();

  void start(const ResourceRequest&);

  void cancel();

  void setDefersLoading(bool);

  void didChangePriority(ResourceLoadPriority, int intraPriorityValue);

  // Called before start() to activate cache-aware loading if enabled in
  // |m_resource->options()| and applicable.
  void activateCacheAwareLoadingIfNeeded(const ResourceRequest&);

  bool isCacheAwareLoadingActivated() const {
    return m_isCacheAwareLoadingActivated;
  }

  // WebURLLoaderClient
  //
  // A succesful load will consist of:
  // 0+  willFollowRedirect()
  // 0+  didSendData()
  // 1   didReceiveResponse()
  // 0-1 didReceiveCachedMetadata()
  // 0+  didReceiveData() or didDownloadData(), but never both
  // 1   didFinishLoading()
  // A failed load is indicated by 1 didFail(), which can occur at any time
  // before didFinishLoading(), including synchronous inside one of the other
  // callbacks via ResourceLoader::cancel()
  bool willFollowRedirect(WebURLRequest&,
                          const WebURLResponse& redirectResponse) override;
  void didSendData(unsigned long long bytesSent,
                   unsigned long long totalBytesToBeSent) override;
  void didReceiveResponse(const WebURLResponse&) override;
  void didReceiveResponse(const WebURLResponse&,
                          std::unique_ptr<WebDataConsumerHandle>) override;
  void didReceiveCachedMetadata(const char* data, int length) override;
  void didReceiveData(const char*, int) override;
  void didReceiveTransferSizeUpdate(int transferSizeDiff) override;
  void didDownloadData(int, int) override;
  void didFinishLoading(double finishTime,
                        int64_t encodedDataLength,
                        int64_t encodedBodyLength) override;
  void didFail(const WebURLError&,
               int64_t encodedDataLength,
               int64_t encodedBodyLength) override;
  void handleError(const ResourceError&);

  void didFinishLoadingFirstPartInMultipart();

 private:
  // Assumes ResourceFetcher and Resource are non-null.
  ResourceLoader(ResourceFetcher*, Resource*);

  // This method is currently only used for service worker fallback request and
  // cache-aware loading, other users should be careful not to break
  // ResourceLoader state.
  void restart(const ResourceRequest&);

  FetchContext& context() const;
  ResourceRequestBlockedReason canAccessResponse(Resource*,
                                                 const ResourceResponse&) const;

  void cancelForRedirectAccessCheckError(const KURL&,
                                         ResourceRequestBlockedReason);
  void requestSynchronously(const ResourceRequest&);
  void dispose();

  std::unique_ptr<WebURLLoader> m_loader;
  Member<ResourceFetcher> m_fetcher;
  Member<Resource> m_resource;
  bool m_isCacheAwareLoadingActivated;
};

}  // namespace blink

#endif