aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/DataCollector/IDataCollector.php
blob: c0e8e03c9a2f49a95a9df66cc505262b11b9b42e (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
<?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;
}