1/*
2 * Copyright (C) 2018 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#if USE(APPLE_INTERNAL_SDK) && ((PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101400) || (PLATFORM(IOS_FAMILY) && __IPHONE_OS_VERSION_MIN_REQUIRED >= 120000) || PLATFORM(WATCHOS))
29#define HAVE_NW_ACTIVITY 1
30#endif
31
32#if HAVE(NW_ACTIVITY)
33#include <nw/private.h>
34#include <wtf/RetainPtr.h>
35#endif
36
37namespace WebKit {
38
39class NetworkActivityTracker {
40public:
41 enum class Domain {
42 // These are defined to match analogous values used in the Darwin implementation.
43 // If they are renumbered, platform-specific code will need to be added to map
44 // them to the Darwin-specific values.
45
46 Invalid = 0,
47 WebKit = 16,
48 };
49
50 enum class Label {
51 // These are ours to define, but once defined, they shouldn't change. They can
52 // be obsolesced and replaced with other codes, but previously-defined codes
53 // should not be renumbered. Previously assigned values should not be re-used.
54
55 Invalid = 0,
56 LoadPage = 1,
57 LoadResource = 2,
58 };
59
60 enum class CompletionCode {
61 Undefined,
62 None,
63 Success,
64 Failure,
65 };
66
67 NetworkActivityTracker() = default;
68 explicit NetworkActivityTracker(Label, Domain = Domain::WebKit);
69 ~NetworkActivityTracker();
70
71 void setParent(NetworkActivityTracker&);
72 void start();
73 void complete(CompletionCode);
74
75#if HAVE(NW_ACTIVITY)
76 nw_activity_t getPlatformObject() { return m_networkActivity.get(); }
77#endif
78
79private:
80#if HAVE(NW_ACTIVITY)
81 Domain m_domain { Domain::Invalid };
82 Label m_label { Label::Invalid };
83 bool m_isCompleted { false };
84 RetainPtr<nw_activity_t> m_networkActivity;
85#endif
86};
87
88} // namespace WebKit
89