Skip to content

Commit 6fab1a3

Browse files
authored
Add a prerelease warning to EventListener (square#3580)
1 parent c323eb2 commit 6fab1a3

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

okhttp/src/main/java/okhttp3/EventListener.java

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,14 @@
2323
import javax.annotation.Nullable;
2424

2525
/**
26-
* EventListener for analytic events for an OkHttpClient instance.
26+
* Listener for metrics events. Extend this class to monitor the quantity, size, and duration of
27+
* your application's HTTP calls.
28+
*
29+
* <h3>Warning: This is a non-final API.</h3>
30+
*
31+
* <p><strong>As of OkHttp 3.9, this feature is an unstable preview: the API is subject to change,
32+
* and the implementation is incomplete. We expect that OkHttp 3.10 or 3.11 will finalize this API.
33+
* Until then, expect API and behavior changes when you update your OkHttp dependency.</strong>
2734
*
2835
* <p>All start/connect/acquire events will eventually receive a matching end/release event,
2936
* either successful (non-null parameters), or failed (non-null throwable). The first common
@@ -275,6 +282,14 @@ public void callEnd(Call call) {
275282
public void callFailed(Call call, IOException ioe) {
276283
}
277284

285+
/**
286+
* <h3>Warning: This is a non-final API.</h3>
287+
*
288+
* <p><strong>As of OkHttp 3.9, this feature is an unstable preview: the API is subject to change,
289+
* and the implementation is incomplete. We expect that OkHttp 3.10 or 3.11 will finalize this
290+
* API. Until then, expect API and behavior changes when you update your OkHttp
291+
* dependency.</strong>
292+
*/
278293
public interface Factory {
279294
/**
280295
* Creates an instance of the {@link EventListener} for a particular {@link Call}. The returned

0 commit comments

Comments
 (0)