Create a WebResourceLoadStatisticsStore attached to the NetworkSession
[WebKit-https.git] / Source / WebKit / NetworkProcess / NetworkSession.h
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 #include <pal/SessionID.h>
29 #include <wtf/HashSet.h>
30 #include <wtf/Ref.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/Seconds.h>
33 #include <wtf/WeakPtr.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WebCore {
37 class NetworkStorageSession;
38 }
39
40 namespace WebKit {
41
42 class NetworkDataTask;
43 class NetworkProcess;
44 class WebResourceLoadStatisticsStore;
45 struct NetworkSessionCreationParameters;
46
47 class NetworkSession : public RefCounted<NetworkSession>, public CanMakeWeakPtr<NetworkSession> {
48 public:
49     static Ref<NetworkSession> create(NetworkProcess&, NetworkSessionCreationParameters&&);
50     virtual ~NetworkSession();
51
52     virtual void invalidateAndCancel();
53     virtual void clearCredentials() { };
54     virtual bool shouldLogCookieInformation() const { return false; }
55     virtual Seconds loadThrottleLatency() const { return { }; }
56
57     PAL::SessionID sessionID() const { return m_sessionID; }
58     NetworkProcess& networkProcess() { return m_networkProcess; }
59     WebCore::NetworkStorageSession& networkStorageSession() const;
60
61     void registerNetworkDataTask(NetworkDataTask& task) { m_dataTaskSet.add(&task); }
62     void unregisterNetworkDataTask(NetworkDataTask& task) { m_dataTaskSet.remove(&task); }
63
64     WebResourceLoadStatisticsStore* resourceLoadStatistics() const { return m_resourceLoadStatistics.get(); }
65     void enableResourceLoadStatistics();
66     
67 protected:
68     NetworkSession(NetworkProcess&, PAL::SessionID);
69
70     PAL::SessionID m_sessionID;
71     Ref<NetworkProcess> m_networkProcess;
72     HashSet<NetworkDataTask*> m_dataTaskSet;
73     String m_resourceLoadStatisticsDirectory;
74     RefPtr<WebResourceLoadStatisticsStore> m_resourceLoadStatistics;
75 };
76
77 } // namespace WebKit