Part 2 of removing PlatformString.h, remove PlatformString.h
[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 KURL;
42 class NetscapePlugInStreamLoader;
43 class NetscapePlugInStreamLoaderClient;
44 class ResourceLoader;
45 class ResourceRequest;
46 class SubresourceLoader;
47
48 class ResourceLoadScheduler {
49     WTF_MAKE_NONCOPYABLE(ResourceLoadScheduler);
50 public:
51     friend ResourceLoadScheduler* resourceLoadScheduler();
52
53     PassRefPtr<SubresourceLoader> scheduleSubresourceLoad(Frame*, CachedResource*, const ResourceRequest&, ResourceLoadPriority, const ResourceLoaderOptions&);
54     PassRefPtr<NetscapePlugInStreamLoader> schedulePluginStreamLoad(Frame*, NetscapePlugInStreamLoaderClient*, const ResourceRequest&);
55     void addMainResourceLoad(ResourceLoader*);
56     void remove(ResourceLoader*);
57     void crossOriginRedirectReceived(ResourceLoader*, const KURL& redirectURL);
58     
59     void servePendingRequests(ResourceLoadPriority minimumPriority = ResourceLoadPriorityVeryLow);
60     bool isSuspendingPendingRequests() const { return !!m_suspendPendingRequestsCount; }
61     void suspendPendingRequests();
62     void resumePendingRequests();
63     
64     bool isSerialLoadingEnabled() const { return m_isSerialLoadingEnabled; }
65     void setSerialLoadingEnabled(bool b) { m_isSerialLoadingEnabled = b; }
66
67 private:
68     ResourceLoadScheduler();
69     ~ResourceLoadScheduler();
70
71     void scheduleLoad(ResourceLoader*, ResourceLoadPriority);
72     void scheduleServePendingRequests();
73     void requestTimerFired(Timer<ResourceLoadScheduler>*);
74
75     class HostInformation {
76         WTF_MAKE_NONCOPYABLE(HostInformation);
77     public:
78         HostInformation(const String&, unsigned);
79         ~HostInformation();
80         
81         const String& name() const { return m_name; }
82         void schedule(ResourceLoader*, ResourceLoadPriority = ResourceLoadPriorityVeryLow);
83         void addLoadInProgress(ResourceLoader*);
84         void remove(ResourceLoader*);
85         bool hasRequests() const;
86         bool limitRequests(ResourceLoadPriority) const;
87
88         typedef Deque<RefPtr<ResourceLoader> > RequestQueue;
89         RequestQueue& requestsPending(ResourceLoadPriority priority) { return m_requestsPending[priority]; }
90
91     private:                    
92         RequestQueue m_requestsPending[ResourceLoadPriorityHighest + 1];
93         typedef HashSet<RefPtr<ResourceLoader> > RequestMap;
94         RequestMap m_requestsLoading;
95         const String m_name;
96         const int m_maxRequestsInFlight;
97     };
98
99     enum CreateHostPolicy {
100         CreateIfNotFound,
101         FindOnly
102     };
103     
104     HostInformation* hostForURL(const KURL&, CreateHostPolicy = FindOnly);
105     void servePendingRequests(HostInformation*, ResourceLoadPriority);
106
107     typedef HashMap<String, HostInformation*, StringHash> HostMap;
108     HostMap m_hosts;
109     HostInformation* m_nonHTTPProtocolHost;
110         
111     Timer<ResourceLoadScheduler> m_requestTimer;
112
113     unsigned m_suspendPendingRequestsCount;
114     bool m_isSerialLoadingEnabled;
115 };
116
117 ResourceLoadScheduler* resourceLoadScheduler();
118
119 }
120
121 #endif