summaryrefslogtreecommitdiffstats
path: root/toolkit/components/glean/bindings/private/Datetime.h
diff options
context:
space:
mode:
Diffstat (limited to 'toolkit/components/glean/bindings/private/Datetime.h')
-rw-r--r--toolkit/components/glean/bindings/private/Datetime.h91
1 files changed, 91 insertions, 0 deletions
diff --git a/toolkit/components/glean/bindings/private/Datetime.h b/toolkit/components/glean/bindings/private/Datetime.h
new file mode 100644
index 0000000000..748766f3be
--- /dev/null
+++ b/toolkit/components/glean/bindings/private/Datetime.h
@@ -0,0 +1,91 @@
+/* -*- 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_GleanDatetime_h
+#define mozilla_glean_GleanDatetime_h
+
+#include "mozilla/Maybe.h"
+#include "nsIGleanMetrics.h"
+#include "mozilla/glean/fog_ffi_generated.h"
+#include "nsString.h"
+#include "prtime.h"
+
+namespace mozilla::glean {
+
+namespace impl {
+
+class DatetimeMetric {
+ public:
+ constexpr explicit DatetimeMetric(uint32_t aId) : mId(aId) {}
+
+ /*
+ * Set the datetime to the provided value, or the local now.
+ *
+ * @param amount The date value to set.
+ */
+ void Set(const PRExplodedTime* aValue = nullptr) const {
+ PRExplodedTime exploded;
+ if (!aValue) {
+ PR_ExplodeTime(PR_Now(), PR_LocalTimeParameters, &exploded);
+ } else {
+ exploded = *aValue;
+ }
+
+ int32_t offset =
+ exploded.tm_params.tp_gmt_offset + exploded.tm_params.tp_dst_offset;
+ fog_datetime_set(mId, exploded.tm_year, exploded.tm_month + 1,
+ exploded.tm_mday, exploded.tm_hour, exploded.tm_min,
+ exploded.tm_sec, exploded.tm_usec * 1000, offset);
+ }
+
+ /**
+ * **Test-only API**
+ *
+ * Gets the currently stored value as an integer.
+ *
+ * This function will attempt to await the last parent-process task (if any)
+ * writing to the the metric's storage engine before returning a value.
+ * This function will not wait for data from child processes.
+ *
+ * This doesn't clear the stored value.
+ * Parent process only. Panics in child processes.
+ *
+ * @param aPingName The (optional) name of the ping to retrieve the metric
+ * for. Defaults to the first value in `send_in_pings`.
+ *
+ * @return value of the stored metric, or Nothing() if there is no value.
+ */
+ Maybe<nsCString> TestGetValue(
+ const nsACString& aPingName = nsCString()) const {
+ if (!fog_datetime_test_has_value(mId, &aPingName)) {
+ return Nothing();
+ }
+ nsCString ret;
+ fog_datetime_test_get_value(mId, &aPingName, &ret);
+ return Some(ret);
+ }
+
+ private:
+ const uint32_t mId;
+};
+} // namespace impl
+
+class GleanDatetime final : public nsIGleanDatetime {
+ public:
+ NS_DECL_ISUPPORTS
+ NS_DECL_NSIGLEANDATETIME
+
+ explicit GleanDatetime(uint32_t aId) : mDatetime(aId){};
+
+ private:
+ virtual ~GleanDatetime() = default;
+
+ const impl::DatetimeMetric mDatetime;
+};
+
+} // namespace mozilla::glean
+
+#endif /* mozilla_glean_GleanDatetime_h */