IpManagerEvent.java revision 95cb226c1a4ff47531da65ef2617ade0dea5c9b8 
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
17package android.net.metrics;
18
19import android.annotation.IntDef;
20import android.os.Parcel;
21import android.os.Parcelable;
22import android.util.SparseArray;
23
24import com.android.internal.util.MessageUtils;
25
26import java.lang.annotation.Retention;
27import java.lang.annotation.RetentionPolicy;
28
29/**
30 * An event recorded by IpManager when IP provisioning completes for a network or
31 * when a network disconnects.
32 * {@hide}
33 */
34public final class IpManagerEvent implements Parcelable {
35
36    public static final int PROVISIONING_OK                       = 1;
37    public static final int PROVISIONING_FAIL                     = 2;
38    public static final int COMPLETE_LIFECYCLE                    = 3;
39    public static final int ERROR_STARTING_IPV4                   = 4;
40    public static final int ERROR_STARTING_IPV6                   = 5;
41    public static final int ERROR_STARTING_IPREACHABILITYMONITOR  = 6;
42
43    @IntDef(value = {
44            PROVISIONING_OK, PROVISIONING_FAIL, COMPLETE_LIFECYCLE,
45            ERROR_STARTING_IPV4, ERROR_STARTING_IPV6, ERROR_STARTING_IPREACHABILITYMONITOR,
46    })
47    @Retention(RetentionPolicy.SOURCE)
48    public @interface EventType {}
49
50    public final String ifName;
51    public final @EventType int eventType;
52    public final long durationMs;
53
54    public IpManagerEvent(String ifName, @EventType int eventType, long duration) {
55        this.ifName = ifName;
56        this.eventType = eventType;
57        this.durationMs = duration;
58    }
59
60    private IpManagerEvent(Parcel in) {
61        this.ifName = in.readString();
62        this.eventType = in.readInt();
63        this.durationMs = in.readLong();
64    }
65
66    @Override
67    public void writeToParcel(Parcel out, int flags) {
68        out.writeString(ifName);
69        out.writeInt(eventType);
70        out.writeLong(durationMs);
71    }
72
73    @Override
74    public int describeContents() {
75        return 0;
76    }
77
78    public static final Parcelable.Creator<IpManagerEvent> CREATOR
79        = new Parcelable.Creator<IpManagerEvent>() {
80        public IpManagerEvent createFromParcel(Parcel in) {
81            return new IpManagerEvent(in);
82        }
83
84        public IpManagerEvent[] newArray(int size) {
85            return new IpManagerEvent[size];
86        }
87    };
88
89    @Override
90    public String toString() {
91        return String.format("IpManagerEvent(%s, %s, %dms)",
92                ifName, Decoder.constants.get(eventType), durationMs);
93    }
94
95    final static class Decoder {
96        static final SparseArray<String> constants = MessageUtils.findMessageNames(
97                new Class[]{IpManagerEvent.class},
98                new String[]{"PROVISIONING_", "COMPLETE_", "ERROR_"});
99    }
100}
101