605f34cc589eb5e63d79828b41d2b6d7e9bc6f53
[WebKit-https.git] / Source / WebCore / loader / ResourceLoadScheduler.h
1 /*
2     Copyright (C) 1998 Lars Knoll (knoll@mpi-hd.mpg.de)
3     Copyright (C) 2001 Dirk Mueller <mueller@kde.org>
4     Copyright (C) 2004, 2006, 2007, 2008 Apple Inc. All rights reserved.
5     Copyright (C) 2010 Google Inc. All rights reserved.
6
7     This library is free software; you can redistribute it and/or
8     modify it under the terms of the GNU Library General Public
9     License as published by the Free Software Foundation; either
10     version 2 of the License, or (at your option) any later version.
11
12     This library is distributed in the hope that it will be useful,
13     but WITHOUT ANY WARRANTY; without even the implied warranty of
14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15     Library General Public License for more details.
16
17     You should have received a copy of the GNU Library General Public License
18     along with this library; see the file COPYING.LIB.  If not, write to
19     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20     Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef ResourceLoadScheduler_h
24 #define ResourceLoadScheduler_h
25
26 #include "FrameLoaderTypes.h"
27 #include "ResourceLoaderOptions.h"
28 #include "ResourceLoadPriority.h"
29 #include "Timer.h"
30 #include <wtf/Deque.h>
31 #include <wtf/HashMap.h>
32 #include <wtf/HashSet.h>
33 #include <wtf/Noncopyable.h>
34 #include <wtf/text/StringHash.h>
35 #include <wtf/text/WTFString.h>
36
37 namespace WebCore {
38
39 class CachedResource;
40 class Frame;
41 class URL;
42 class NetscapePlugInStreamLoader;
43 class NetscapePlugInStreamLoaderClient;
44 class ResourceLoader;
45 class ResourceRequest;
46 class SubresourceLoader;
47
48 class ResourceLoadScheduler {
49     WTF_MAKE_NONCOPYABLE(ResourceLoadScheduler); WTF_MAKE_FAST_ALLOCATED;
50 public:
51     friend ResourceLoadScheduler* resourceLoadScheduler();
52
53     virtual PassRefPtr<SubresourceLoader> scheduleSubresourceLoad(Frame*, CachedResource*, const ResourceRequest&, ResourceLoadPriority, const ResourceLoaderOptions&);
54     virtual PassRefPtr<NetscapePlugInStreamLoader> schedulePluginStreamLoad(Frame*, NetscapePlugInStreamLoaderClient*, const ResourceRequest&);
55     virtual void remove(ResourceLoader*);
56     virtual void crossOriginRedirectReceived(ResourceLoader*, const URL& redirectURL);
57     
58     virtual void servePendingRequests(ResourceLoadPriority minimumPriority = ResourceLoadPriorityVeryLow);
59     virtual void suspendPendingRequests();
60     virtual void resumePendingRequests();
61     
62     bool isSerialLoadingEnabled() const { return m_isSerialLoadingEnabled; }
63     virtual void setSerialLoadingEnabled(bool b) { m_isSerialLoadingEnabled = b; }
64
65 protected:
66     ResourceLoadScheduler();
67     virtual ~ResourceLoadScheduler();
68
69     void notifyDidScheduleResourceRequest(ResourceLoader*);
70
71 private:
72     void scheduleLoad(ResourceLoader*, ResourceLoadPriority);
73     void scheduleServePendingRequests();
74     void requestTimerFired(Timer<ResourceLoadScheduler>*);
75
76     bool isSuspendingPendingRequests() const { return !!m_suspendPendingRequestsCount; }
77
78     class HostInformation {
79         WTF_MAKE_NONCOPYABLE(HostInformation); WTF_MAKE_FAST_ALLOCATED;
80     public:
81         HostInformation(const String&, unsigned);
82         ~HostInformation();
83         
84         const String& name() const { return m_name; }
85         void schedule(ResourceLoader*, ResourceLoadPriority = ResourceLoadPriorityVeryLow);
86         void addLoadInProgress(ResourceLoader*);
87         void remove(ResourceLoader*);
88         bool hasRequests() const;
89         bool limitRequests(ResourceLoadPriority) const;
90
91         typedef Deque<RefPtr<ResourceLoader>> RequestQueue;
92         RequestQueue& requestsPending(ResourceLoadPriority priority) { return m_requestsPending[priority]; }
93
94     private:                    
95         RequestQueue m_requestsPending[ResourceLoadPriorityHighest + 1];
96         typedef HashSet<RefPtr<ResourceLoader>> RequestMap;
97         RequestMap m_requestsLoading;
98         const String m_name;
99         const int m_maxRequestsInFlight;
100     };
101
102     enum CreateHostPolicy {
103         CreateIfNotFound,
104         FindOnly
105     };
106     
107     HostInformation* hostForURL(const URL&, CreateHostPolicy = FindOnly);
108     void servePendingRequests(HostInformation*, ResourceLoadPriority);
109
110     typedef HashMap<String, HostInformation*, StringHash> HostMap;
111     HostMap m_hosts;
112     HostInformation* m_nonHTTPProtocolHost;
113         
114     Timer<ResourceLoadScheduler> m_requestTimer;
115
116     unsigned m_suspendPendingRequestsCount;
117     bool m_isSerialLoadingEnabled;
118 };
119
120 ResourceLoadScheduler* resourceLoadScheduler();
121
122 }
123
124 #endif