Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.net.metrics; |
| 18 | |
Hugo Benichi | cf6b12f | 2016-07-04 11:28:05 +0900 | [diff] [blame] | 19 | import android.annotation.IntDef; |
Remi NGUYEN VAN | 7b84fb3 | 2019-01-19 21:13:24 +0900 | [diff] [blame] | 20 | import android.annotation.SystemApi; |
| 21 | import android.annotation.TestApi; |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 22 | import android.os.Parcel; |
| 23 | import android.os.Parcelable; |
Hugo Benichi | 5df9d72 | 2016-04-25 17:16:35 +0900 | [diff] [blame] | 24 | import android.util.SparseArray; |
| 25 | |
| 26 | import com.android.internal.util.MessageUtils; |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 27 | |
Hugo Benichi | cf6b12f | 2016-07-04 11:28:05 +0900 | [diff] [blame] | 28 | import java.lang.annotation.Retention; |
| 29 | import java.lang.annotation.RetentionPolicy; |
| 30 | |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 31 | /** |
| 32 | * {@hide} |
| 33 | */ |
Remi NGUYEN VAN | 7b84fb3 | 2019-01-19 21:13:24 +0900 | [diff] [blame] | 34 | @SystemApi |
| 35 | @TestApi |
| 36 | public final class NetworkEvent implements IpConnectivityLog.Event { |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 37 | |
| 38 | public static final int NETWORK_CONNECTED = 1; |
| 39 | public static final int NETWORK_VALIDATED = 2; |
| 40 | public static final int NETWORK_VALIDATION_FAILED = 3; |
| 41 | public static final int NETWORK_CAPTIVE_PORTAL_FOUND = 4; |
| 42 | public static final int NETWORK_LINGER = 5; |
| 43 | public static final int NETWORK_UNLINGER = 6; |
| 44 | public static final int NETWORK_DISCONNECTED = 7; |
| 45 | |
Hugo Benichi | 147aa6d | 2016-11-15 23:23:24 +0900 | [diff] [blame] | 46 | public static final int NETWORK_FIRST_VALIDATION_SUCCESS = 8; |
Hugo Benichi | 147aa6d | 2016-11-15 23:23:24 +0900 | [diff] [blame] | 47 | public static final int NETWORK_REVALIDATION_SUCCESS = 9; |
Hugo Benichi | 147aa6d | 2016-11-15 23:23:24 +0900 | [diff] [blame] | 48 | public static final int NETWORK_FIRST_VALIDATION_PORTAL_FOUND = 10; |
Hugo Benichi | 147aa6d | 2016-11-15 23:23:24 +0900 | [diff] [blame] | 49 | public static final int NETWORK_REVALIDATION_PORTAL_FOUND = 11; |
| 50 | |
Chiachang Wang | 7a70a7e | 2018-11-27 18:00:05 +0800 | [diff] [blame] | 51 | public static final int NETWORK_CONSECUTIVE_DNS_TIMEOUT_FOUND = 12; |
| 52 | |
Remi NGUYEN VAN | 7b84fb3 | 2019-01-19 21:13:24 +0900 | [diff] [blame] | 53 | /** @hide */ |
Hugo Benichi | cf6b12f | 2016-07-04 11:28:05 +0900 | [diff] [blame] | 54 | @IntDef(value = { |
| 55 | NETWORK_CONNECTED, |
| 56 | NETWORK_VALIDATED, |
| 57 | NETWORK_VALIDATION_FAILED, |
| 58 | NETWORK_CAPTIVE_PORTAL_FOUND, |
| 59 | NETWORK_LINGER, |
| 60 | NETWORK_UNLINGER, |
| 61 | NETWORK_DISCONNECTED, |
Hugo Benichi | 147aa6d | 2016-11-15 23:23:24 +0900 | [diff] [blame] | 62 | NETWORK_FIRST_VALIDATION_SUCCESS, |
| 63 | NETWORK_REVALIDATION_SUCCESS, |
| 64 | NETWORK_FIRST_VALIDATION_PORTAL_FOUND, |
| 65 | NETWORK_REVALIDATION_PORTAL_FOUND, |
Chiachang Wang | 7a70a7e | 2018-11-27 18:00:05 +0800 | [diff] [blame] | 66 | NETWORK_CONSECUTIVE_DNS_TIMEOUT_FOUND, |
Hugo Benichi | cf6b12f | 2016-07-04 11:28:05 +0900 | [diff] [blame] | 67 | }) |
| 68 | @Retention(RetentionPolicy.SOURCE) |
| 69 | public @interface EventType {} |
| 70 | |
Remi NGUYEN VAN | 7b84fb3 | 2019-01-19 21:13:24 +0900 | [diff] [blame] | 71 | /** @hide */ |
Hugo Benichi | cf6b12f | 2016-07-04 11:28:05 +0900 | [diff] [blame] | 72 | public final @EventType int eventType; |
Remi NGUYEN VAN | 7b84fb3 | 2019-01-19 21:13:24 +0900 | [diff] [blame] | 73 | /** @hide */ |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 74 | public final long durationMs; |
| 75 | |
Hugo Benichi | 97bfd27 | 2017-11-11 08:06:43 +0900 | [diff] [blame] | 76 | public NetworkEvent(@EventType int eventType, long durationMs) { |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 77 | this.eventType = eventType; |
| 78 | this.durationMs = durationMs; |
| 79 | } |
| 80 | |
Hugo Benichi | 97bfd27 | 2017-11-11 08:06:43 +0900 | [diff] [blame] | 81 | public NetworkEvent(@EventType int eventType) { |
| 82 | this(eventType, 0); |
Hugo Benichi | cfddd68 | 2016-05-31 16:28:06 +0900 | [diff] [blame] | 83 | } |
| 84 | |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 85 | private NetworkEvent(Parcel in) { |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 86 | eventType = in.readInt(); |
| 87 | durationMs = in.readLong(); |
| 88 | } |
| 89 | |
Remi NGUYEN VAN | 7b84fb3 | 2019-01-19 21:13:24 +0900 | [diff] [blame] | 90 | /** @hide */ |
Hugo Benichi | cf6b12f | 2016-07-04 11:28:05 +0900 | [diff] [blame] | 91 | @Override |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 92 | public void writeToParcel(Parcel out, int flags) { |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 93 | out.writeInt(eventType); |
| 94 | out.writeLong(durationMs); |
| 95 | } |
| 96 | |
Remi NGUYEN VAN | 7b84fb3 | 2019-01-19 21:13:24 +0900 | [diff] [blame] | 97 | /** @hide */ |
Hugo Benichi | cf6b12f | 2016-07-04 11:28:05 +0900 | [diff] [blame] | 98 | @Override |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 99 | public int describeContents() { |
| 100 | return 0; |
| 101 | } |
| 102 | |
Remi NGUYEN VAN | 7b84fb3 | 2019-01-19 21:13:24 +0900 | [diff] [blame] | 103 | /** @hide */ |
Hugo Benichi | cc92c6e | 2016-04-21 15:02:38 +0900 | [diff] [blame] | 104 | public static final Parcelable.Creator<NetworkEvent> CREATOR |
| 105 | = new Parcelable.Creator<NetworkEvent>() { |
| 106 | public NetworkEvent createFromParcel(Parcel in) { |
| 107 | return new NetworkEvent(in); |
| 108 | } |
| 109 | |
| 110 | public NetworkEvent[] newArray(int size) { |
| 111 | return new NetworkEvent[size]; |
| 112 | } |
| 113 | }; |
| 114 | |
Hugo Benichi | 5df9d72 | 2016-04-25 17:16:35 +0900 | [diff] [blame] | 115 | @Override |
| 116 | public String toString() { |
Hugo Benichi | 97bfd27 | 2017-11-11 08:06:43 +0900 | [diff] [blame] | 117 | return String.format("NetworkEvent(%s, %dms)", |
| 118 | Decoder.constants.get(eventType), durationMs); |
Hugo Benichi | 5df9d72 | 2016-04-25 17:16:35 +0900 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | final static class Decoder { |
| 122 | static final SparseArray<String> constants = MessageUtils.findMessageNames( |
| 123 | new Class[]{NetworkEvent.class}, new String[]{"NETWORK_"}); |
| 124 | } |
Hugo Benichi | cfddd68 | 2016-05-31 16:28:06 +0900 | [diff] [blame] | 125 | } |