summaryrefslogtreecommitdiff
path: root/components/docshell/src/timeline/DocLoadingTimelineMarker.h
blob: 4e1c09a46c69ced58cc74f1f34233a3b65e3632b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_DocLoadingTimelineMarker_h_
#define mozilla_DocLoadingTimelineMarker_h_

#include "TimelineMarker.h"
#include "mozilla/dom/ProfileTimelineMarkerBinding.h"

namespace mozilla {

class DocLoadingTimelineMarker : public TimelineMarker
{
public:
  explicit DocLoadingTimelineMarker(const char* aName)
    : TimelineMarker(aName, MarkerTracingType::TIMESTAMP)
    , mUnixTime(PR_Now())
  {}

  virtual void AddDetails(JSContext* aCx, dom::ProfileTimelineMarker& aMarker) override
  {
    TimelineMarker::AddDetails(aCx, aMarker);
    aMarker.mUnixTime.Construct(mUnixTime);
  }

private:
  // Certain consumers might use Date.now() or similar for tracing time.
  // However, TimelineMarkers use process creation as an epoch, which provides
  // more precision. To allow syncing, attach an additional unix timestamp.
  // Using this instead of `AbstractTimelineMarker::GetTime()'s` timestamp
  // is strongly discouraged.
  PRTime mUnixTime;
};

} // namespace mozilla

#endif // mozilla_DocLoadingTimelineMarker_h_