summaryrefslogtreecommitdiffstats
path: root/xpcom/base/MemoryReportingProcess.h
blob: 36410e702b46272c556461748b999c3f18a98875 (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
40
41
42
43
44
45
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 xpcom_base_MemoryReportingProcess_h
#define xpcom_base_MemoryReportingProcess_h

#include <stdint.h>
#include "nscore.h"

namespace mozilla {
namespace ipc {
class FileDescriptor;
}  // namespace ipc

template <class T>
class Maybe;

// Top-level process actors should implement this to integrate with
// nsMemoryReportManager.
class MemoryReportingProcess {
 public:
  NS_IMETHOD_(MozExternalRefCountType) AddRef() = 0;
  NS_IMETHOD_(MozExternalRefCountType) Release() = 0;

  virtual ~MemoryReportingProcess() = default;

  // Return true if the process is still alive, false otherwise.
  virtual bool IsAlive() const = 0;

  // Initiate a memory report request, returning true if a report was
  // successfully initiated and false otherwise.
  virtual bool SendRequestMemoryReport(
      const uint32_t& aGeneration, const bool& aAnonymize,
      const bool& aMinimizeMemoryUsage,
      const Maybe<mozilla::ipc::FileDescriptor>& aDMDFile) = 0;

  virtual int32_t Pid() const = 0;
};

}  // namespace mozilla

#endif  // xpcom_base_MemoryReportingProcess_h