a7e4567755ea1a254c0c9d255b0eb7428bf2953b
[WebKit-https.git] / Source / WebKit / NetworkProcess / NetworkSessionCreationParameters.h
1 /*
2  * Copyright (C) 2017 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 "ArgumentCoders.h"
29 #include <pal/SessionID.h>
30 #include <wtf/EnumTraits.h>
31 #include <wtf/text/WTFString.h>
32
33 namespace WebKit {
34
35 class LegacyCustomProtocolManager;
36
37 enum class AllowsCellularAccess { No, Yes };
38     
39 struct NetworkSessionCreationParameters {
40     void encode(IPC::Encoder&) const;
41     static std::optional<NetworkSessionCreationParameters> decode(IPC::Decoder&);
42     
43     PAL::SessionID sessionID { PAL::SessionID::defaultSessionID() };
44     LegacyCustomProtocolManager* legacyCustomProtocolManager { nullptr };
45     String boundInterfaceIdentifier;
46     AllowsCellularAccess allowsCellularAccess { AllowsCellularAccess::Yes };
47 };
48
49 inline void NetworkSessionCreationParameters::encode(IPC::Encoder& encoder) const
50 {
51     encoder << sessionID;
52     encoder << boundInterfaceIdentifier;
53     encoder << allowsCellularAccess;
54 }
55
56 inline std::optional<NetworkSessionCreationParameters> NetworkSessionCreationParameters::decode(IPC::Decoder& decoder)
57 {
58     PAL::SessionID sessionID;
59     if (!decoder.decode(sessionID))
60         return std::nullopt;
61
62     std::optional<String> boundInterfaceIdentifier;
63     decoder >> boundInterfaceIdentifier;
64     if (!boundInterfaceIdentifier)
65         return std::nullopt;
66
67     std::optional<AllowsCellularAccess> allowsCellularAccess;
68     decoder >> allowsCellularAccess;
69     if (!allowsCellularAccess)
70         return std::nullopt;
71
72     return {{ sessionID, nullptr, WTFMove(*boundInterfaceIdentifier), WTFMove(*allowsCellularAccess) }};
73 }
74
75 } // namespace WebKit
76
77 namespace WTF {
78 template<> struct EnumTraits<WebKit::AllowsCellularAccess> {
79     using values = EnumValues<
80         WebKit::AllowsCellularAccess,
81         WebKit::AllowsCellularAccess::No,
82         WebKit::AllowsCellularAccess::Yes
83     >;
84 };
85 }