Skip to content

Commit

Permalink
Add a prerelease warning to EventListener (square#3580)
Browse files Browse the repository at this point in the history
  • Loading branch information
swankjesse authored Sep 4, 2017
1 parent c323eb2 commit 6fab1a3
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion okhttp/src/main/java/okhttp3/EventListener.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,14 @@
import javax.annotation.Nullable;

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

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

0 comments on commit 6fab1a3

Please sign in to comment.