Share more code between NETWORK_SESSION and non-NETWORK_SESSION NetworkResourceLoaders
[WebKit-https.git] / Source / WebKit2 / 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 #ifndef NetworkSession_h
27 #define NetworkSession_h
28
29 OBJC_CLASS NSURLSession;
30 OBJC_CLASS NSURLSessionDataTask;
31 OBJC_CLASS NSOperationQueue;
32 OBJC_CLASS NetworkSessionDelegate;
33
34 #include <wtf/HashMap.h>
35 #include <wtf/Ref.h>
36 #include <wtf/RefCounted.h>
37 #include <wtf/RetainPtr.h>
38 #include <wtf/WeakPtr.h>
39
40 namespace WebCore {
41 class AuthenticationChallenge;
42 class Credential;
43 class ResourceError;
44 class ResourceRequest;
45 class ResourceResponse;
46 class SharedBuffer;
47 }
48
49 namespace WebKit {
50
51 enum class ResponseDisposition {
52     Cancel,
53     Allow,
54     BecomeDownload
55 };
56
57 enum class AuthenticationChallengeDisposition {
58     UseCredential,
59     PerformDefaultHandling,
60     Cancel,
61     RejectProtectionSpace
62 };
63
64 class NetworkSession;
65
66 class NetworkSessionTaskClient {
67 public:
68     virtual void willPerformHTTPRedirection(const WebCore::ResourceResponse&, const WebCore::ResourceRequest&, std::function<void(const WebCore::ResourceRequest&)>) = 0;
69     virtual void didReceiveChallenge(const WebCore::AuthenticationChallenge&, std::function<void(AuthenticationChallengeDisposition, const WebCore::Credential&)>) = 0;
70     virtual void didReceiveResponse(const WebCore::ResourceResponse&, std::function<void(ResponseDisposition)>) = 0;
71     virtual void didReceiveData(RefPtr<WebCore::SharedBuffer>&&) = 0;
72     virtual void didCompleteWithError(const WebCore::ResourceError&) = 0;
73
74     virtual ~NetworkSessionTaskClient() { }
75 };
76
77 class NetworkingDataTask : public RefCounted<NetworkingDataTask> {
78     friend class NetworkSession;
79 public:
80     void suspend();
81     void resume();
82
83     uint64_t taskIdentifier();
84
85     ~NetworkingDataTask();
86
87     NetworkSessionTaskClient* client() { return m_client; }
88     void clearClient() { m_client = nullptr; }
89
90 private:
91     explicit NetworkingDataTask(NetworkSession&, NetworkSessionTaskClient&, RetainPtr<NSURLSessionDataTask>);
92
93     NetworkSession& m_session;
94     RetainPtr<NSURLSessionDataTask> m_task;
95     NetworkSessionTaskClient* m_client;
96 };
97
98 class NetworkSession : public RefCounted<NetworkSession> {
99     friend class NetworkingDataTask;
100 public:
101     enum class Type {
102         Normal,
103         Ephemeral
104     };
105
106     RefPtr<NetworkingDataTask> createDataTaskWithRequest(const WebCore::ResourceRequest&, NetworkSessionTaskClient&);
107
108     static Ref<NetworkSession> singleton(); // FIXME: This shouldn't actually be a singleton.
109     NetworkingDataTask* dataTaskForIdentifier(uint64_t);
110
111     ~NetworkSession() { ASSERT(m_dataTaskMap.isEmpty()); }
112 private:
113     static Ref<NetworkSession> create(Type);
114
115     NetworkSession(Type);
116     HashMap<uint64_t, NetworkingDataTask*> m_dataTaskMap;
117     RetainPtr<NSURLSession> m_session;
118     RetainPtr<NetworkSessionDelegate> m_sessionDelegate;
119 };
120
121 } // namespace WebKit
122
123 #endif // NetworkSession_h