blob: 2a92d87995ecf8fd1583acb3b803a8981892a899 (
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
/* -*- 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 mozilla_glean_Ping_h
#define mozilla_glean_Ping_h
#include "mozilla/DataMutex.h"
#include "mozilla/glean/fog_ffi_generated.h"
#include "mozilla/Maybe.h"
#include "nsIGleanPing.h"
#include "nsString.h"
namespace mozilla::glean {
typedef std::function<void(const nsACString& aReason)> PingTestCallback;
namespace impl {
class Ping {
public:
constexpr explicit Ping(uint32_t aId) : mId(aId) {}
/**
* Collect and submit the ping for eventual upload.
*
* This will collect all stored data to be included in the ping.
* Data with lifetime `ping` will then be reset.
*
* If the ping is configured with `send_if_empty = false`
* and the ping currently contains no content,
* it will not be queued for upload.
* If the ping is configured with `send_if_empty = true`
* it will be queued for upload even if empty.
*
* Pings always contain the `ping_info` and `client_info` sections.
* See [ping
* sections](https://mozilla.github.io/glean/book/user/pings/index.html#ping-sections)
* for details.
*
* @param aReason - Optional. The reason the ping is being submitted.
* Must match one of the configured `reason_codes`.
*/
void Submit(const nsACString& aReason = nsCString()) const;
/**
* **Test-only API**
*
* Register a callback to be called right before this ping is next submitted.
* The provided function is called exactly once before submitting.
*
* Note: The callback will be called on any call to submit.
* A ping may not be sent afterwards, e.g. if the ping is empty and
* `send_if_empty` is `false`
*
* @param aCallback - The callback to call on the next submit.
*/
void TestBeforeNextSubmit(PingTestCallback&& aCallback) const;
private:
const uint32_t mId;
};
} // namespace impl
class GleanPing final : public nsIGleanPing {
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIGLEANPING
explicit GleanPing(uint32_t aId) : mPing(aId) {}
private:
virtual ~GleanPing() = default;
const impl::Ping mPing;
};
} // namespace mozilla::glean
#endif /* mozilla_glean_Ping_h */
|
