dom/performance/PerformanceNavigationTiming.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_PerformanceNavigationTiming_h___
   8 #define mozilla_dom_PerformanceNavigationTiming_h___
   9
  10 #include <stdint.h>
  11 #include <utility>
  12 #include "js/RootingAPI.h"
  13 #include "mozilla/UniquePtr.h"
  14 #include "mozilla/dom/PerformanceNavigationTimingBinding.h"
  15 #include "mozilla/dom/PerformanceResourceTiming.h"
  16 #include "nsDOMNavigationTiming.h"
  17 #include "nsISupports.h"
  18 #include "nsLiteralString.h"
  19 #include "nsString.h"
  20 #include "nsTLiteralString.h"
  21
  22 class JSObject;
  23 class nsIHttpChannel;
  24 class nsITimedChannel;
  25 struct JSContext;
  26
  27 namespace mozilla::dom {
  28
  29 class Performance;
  30 class PerformanceTimingData;
  31
  32 // https://www.w3.org/TR/navigation-timing-2/#sec-PerformanceNavigationTiming
  33 class PerformanceNavigationTiming final : public PerformanceResourceTiming {
  34  public:
  35   NS_DECL_ISUPPORTS_INHERITED
  36
  37   // Note that aPerformanceTiming must be initalized with zeroTime = 0
  38   // so that timestamps are relative to startTime, as opposed to the
  39   // performance.timing object for which timestamps are absolute and has a
  40   // zeroTime initialized to navigationStart
  41   // aPerformanceTiming and aPerformance must be non-null.
  42   PerformanceNavigationTiming(
  43       UniquePtr<PerformanceTimingData>&& aPerformanceTiming,
  44       Performance* aPerformance, const nsAString& aName)
  45       : PerformanceResourceTiming(std::move(aPerformanceTiming), aPerformance,
  46                                   aName) {
  47     SetEntryType(u"navigation"_ns);
  48     SetInitiatorType(u"navigation"_ns);
  49   }
  50
  51   DOMHighResTimeStamp Duration() const override {
  52     return LoadEventEnd() - StartTime();
  53   }
  54
  55   DOMHighResTimeStamp StartTime() const override { return 0; }
  56
  57   JSObject* WrapObject(JSContext* aCx,
  58                        JS::Handle<JSObject*> aGivenProto) override;
  59
  60   DOMHighResTimeStamp UnloadEventStart() const;
  61   DOMHighResTimeStamp UnloadEventEnd() const;
  62
  63   DOMHighResTimeStamp DomInteractive() const;
  64   DOMHighResTimeStamp DomContentLoadedEventStart() const;
  65   DOMHighResTimeStamp DomContentLoadedEventEnd() const;
  66   DOMHighResTimeStamp DomComplete() const;
  67   DOMHighResTimeStamp LoadEventStart() const;
  68   DOMHighResTimeStamp LoadEventEnd() const;
  69
  70   DOMHighResTimeStamp RedirectStart(
  71       nsIPrincipal& aSubjectPrincipal) const override;
  72   DOMHighResTimeStamp RedirectEnd(
  73       nsIPrincipal& aSubjectPrincipal) const override;
  74
  75   NavigationTimingType Type() const;
  76   uint16_t RedirectCount() const;
  77
  78   void UpdatePropertiesFromHttpChannel(nsIHttpChannel* aHttpChannel,
  79                                        nsITimedChannel* aChannel);
  80
  81   /*
  82    * For use with the WebIDL Func attribute to determine whether
  83    * window.PerformanceNavigationTiming is exposed.
  84    */
  85   static bool Enabled(JSContext* aCx, JSObject* aGlobal);
  86
  87  private:
  88   ~PerformanceNavigationTiming() = default;
  89 };
  90
  91 }  // namespace mozilla::dom
  92
  93 #endif  // mozilla_dom_PerformanceNavigationTiming_h___