Disable outdated WritableStream API
[WebKit-https.git] / Source / WebCore / page / SessionID.h
1 /*
2  * Copyright (C) 2014 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 <wtf/HashFunctions.h>
29 #include <wtf/HashTraits.h>
30
31 namespace WebCore {
32
33 class SessionID {
34 public:
35     SessionID()
36         : SessionID(emptySessionID()) { }
37     explicit SessionID(uint64_t sessionID)
38         : m_sessionID(sessionID) { }
39     bool isValid() const { return *this != emptySessionID(); }
40     bool isEphemeral() const { return *this != defaultSessionID(); }
41     uint64_t sessionID() const { return m_sessionID; }
42     bool operator==(SessionID sessionID) const { return m_sessionID == sessionID.m_sessionID; }
43     bool operator!=(SessionID sessionID) const { return m_sessionID != sessionID.m_sessionID; }
44     bool isAlwaysOnLoggingAllowed() const { return !isEphemeral(); }
45
46     static SessionID emptySessionID() { return SessionID(0); }
47     static SessionID defaultSessionID() { return SessionID(1); }
48     static SessionID legacyPrivateSessionID() { return SessionID(2); }
49 private:
50     uint64_t m_sessionID;
51 };
52
53 } // namespace WebCore
54
55 namespace WTF {
56
57 // The empty value is emptySessionID(), the deleted value is (-1)
58 struct SessionIDHash {
59     static unsigned hash(const WebCore::SessionID& p) { return intHash(p.sessionID()); }
60     static bool equal(const WebCore::SessionID& a, const WebCore::SessionID& b) { return a == b; }
61     static const bool safeToCompareToEmptyOrDeleted = true;
62 };
63 template<> struct HashTraits<WebCore::SessionID> : GenericHashTraits<WebCore::SessionID> {
64     static const uint64_t deletedValueIdentifier = std::numeric_limits<uint64_t>::max();
65     static WebCore::SessionID emptyValue() { return WebCore::SessionID::emptySessionID(); }
66
67     static void constructDeletedValue(WebCore::SessionID& slot) { slot = WebCore::SessionID(deletedValueIdentifier); }
68     static bool isDeletedValue(const WebCore::SessionID& slot) { return slot == WebCore::SessionID(deletedValueIdentifier); }
69 };
70 template<> struct DefaultHash<WebCore::SessionID> {
71     typedef SessionIDHash Hash;
72 };
73
74 } // namespace WTF