aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/DataCollector/IDataCollector.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/DataCollector/IDataCollector.php')
-rw-r--r--lib/public/DataCollector/IDataCollector.php37
1 files changed, 37 insertions, 0 deletions
diff --git a/lib/public/DataCollector/IDataCollector.php b/lib/public/DataCollector/IDataCollector.php
new file mode 100644
index 00000000000..c0e8e03c9a2
--- /dev/null
+++ b/lib/public/DataCollector/IDataCollector.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\DataCollector;
+
+use OC\AppFramework\Http\Request;
+use OCP\AppFramework\Http\Response;
+
+/**
+ * DataCollectorInterface.
+ *
+ * @since 24.0.0
+ */
+interface IDataCollector {
+ /**
+ * Collects data for the given Request and Response.
+ * @since 24.0.0
+ */
+ public function collect(Request $request, Response $response, ?\Throwable $exception = null): void;
+
+ /**
+ * Reset the state of the profiler.
+ * @since 24.0.0
+ */
+ public function reset(): void;
+
+ /**
+ * Returns the name of the collector.
+ * @since 24.0.0
+ */
+ public function getName(): string;
+}