NetworkPolicy.java revision 9bf3150cfae03421c9dd237b46657714859d871c
121c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey/* 221c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * Copyright (C) 2011 The Android Open Source Project 321c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * 421c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * Licensed under the Apache License, Version 2.0 (the "License"); 521c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * you may not use this file except in compliance with the License. 621c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * You may obtain a copy of the License at 721c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * 821c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * http://www.apache.org/licenses/LICENSE-2.0 921c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * 1021c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * Unless required by applicable law or agreed to in writing, software 1121c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * distributed under the License is distributed on an "AS IS" BASIS, 1221c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1321c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * See the License for the specific language governing permissions and 1421c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * limitations under the License. 1521c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey */ 1621c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 1721c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkeypackage android.net; 1821c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 191b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkeyimport static com.android.internal.util.Preconditions.checkNotNull; 201b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkey 2121c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkeyimport android.os.Parcel; 2221c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkeyimport android.os.Parcelable; 2321c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 2441ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkeyimport com.android.internal.util.Objects; 2541ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey 2621c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey/** 271b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkey * Policy for networks matching a {@link NetworkTemplate}, including usage cycle 281b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkey * and limits to be enforced. 2921c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * 3021c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey * @hide 3121c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey */ 3221c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkeypublic class NetworkPolicy implements Parcelable, Comparable<NetworkPolicy> { 331b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkey public static final long WARNING_DISABLED = -1; 341b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkey public static final long LIMIT_DISABLED = -1; 3541ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey public static final long SNOOZE_NEVER = -1; 361b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkey 371b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkey public final NetworkTemplate template; 3822c055e6424e0e9579711545d8f4800c0f796db8Jeff Sharkey public int cycleDay; 399bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey public String cycleTimezone; 4022c055e6424e0e9579711545d8f4800c0f796db8Jeff Sharkey public long warningBytes; 4122c055e6424e0e9579711545d8f4800c0f796db8Jeff Sharkey public long limitBytes; 420e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey public long lastWarningSnooze; 430e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey public long lastLimitSnooze; 44f60d0afd1ef08a24121d015bb016df05265b6d07Jeff Sharkey public boolean metered; 4521c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 4650e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey private static final long DEFAULT_MTU = 1500; 4750e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey 489bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey public NetworkPolicy(NetworkTemplate template, int cycleDay, String cycleTimezone, 499bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey long warningBytes, long limitBytes, boolean metered) { 509bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey this(template, cycleDay, cycleTimezone, warningBytes, limitBytes, SNOOZE_NEVER, 519bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey SNOOZE_NEVER, metered); 520e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey } 530e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey 549bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey public NetworkPolicy(NetworkTemplate template, int cycleDay, String cycleTimezone, 559bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey long warningBytes, long limitBytes, long lastWarningSnooze, long lastLimitSnooze, 569bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey boolean metered) { 571b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkey this.template = checkNotNull(template, "missing NetworkTemplate"); 5821c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey this.cycleDay = cycleDay; 599bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey this.cycleTimezone = checkNotNull(cycleTimezone, "missing cycleTimezone"); 6021c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey this.warningBytes = warningBytes; 6121c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey this.limitBytes = limitBytes; 620e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey this.lastWarningSnooze = lastWarningSnooze; 630e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey this.lastLimitSnooze = lastLimitSnooze; 64f60d0afd1ef08a24121d015bb016df05265b6d07Jeff Sharkey this.metered = metered; 6521c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey } 6621c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 6721c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey public NetworkPolicy(Parcel in) { 681b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkey template = in.readParcelable(null); 6921c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey cycleDay = in.readInt(); 709bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey cycleTimezone = in.readString(); 7121c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey warningBytes = in.readLong(); 7221c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey limitBytes = in.readLong(); 730e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey lastWarningSnooze = in.readLong(); 740e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey lastLimitSnooze = in.readLong(); 75f60d0afd1ef08a24121d015bb016df05265b6d07Jeff Sharkey metered = in.readInt() != 0; 7621c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey } 7721c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 789bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey @Override 7921c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey public void writeToParcel(Parcel dest, int flags) { 801b5a2a96f793211bfbd39aa29cc41031dfa23950Jeff Sharkey dest.writeParcelable(template, flags); 8121c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey dest.writeInt(cycleDay); 829bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey dest.writeString(cycleTimezone); 8321c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey dest.writeLong(warningBytes); 8421c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey dest.writeLong(limitBytes); 850e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey dest.writeLong(lastWarningSnooze); 860e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey dest.writeLong(lastLimitSnooze); 87f60d0afd1ef08a24121d015bb016df05265b6d07Jeff Sharkey dest.writeInt(metered ? 1 : 0); 8821c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey } 8921c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 909bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey @Override 9121c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey public int describeContents() { 9221c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey return 0; 9321c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey } 9421c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 9550e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey /** 960e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey * Test if given measurement is over {@link #warningBytes}. 970e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey */ 980e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey public boolean isOverWarning(long totalBytes) { 990e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey return warningBytes != WARNING_DISABLED && totalBytes >= warningBytes; 1000e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey } 1010e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey 1020e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey /** 10350e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey * Test if given measurement is near enough to {@link #limitBytes} to be 10450e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey * considered over-limit. 10550e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey */ 10650e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey public boolean isOverLimit(long totalBytes) { 10750e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey // over-estimate, since kernel will trigger limit once first packet 10850e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey // trips over limit. 10950e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey totalBytes += 2 * DEFAULT_MTU; 11050e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey return limitBytes != LIMIT_DISABLED && totalBytes >= limitBytes; 11150e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey } 11250e7e51d68e3b01c3362fe9ab7b3448132e48b43Jeff Sharkey 1130e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey /** 1140e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey * Clear any existing snooze values, setting to {@link #SNOOZE_NEVER}. 1150e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey */ 1160e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey public void clearSnooze() { 1170e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey lastWarningSnooze = SNOOZE_NEVER; 1180e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey lastLimitSnooze = SNOOZE_NEVER; 1190e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey } 1200e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey 1219bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey @Override 12221c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey public int compareTo(NetworkPolicy another) { 12322c055e6424e0e9579711545d8f4800c0f796db8Jeff Sharkey if (another == null || another.limitBytes == LIMIT_DISABLED) { 12422c055e6424e0e9579711545d8f4800c0f796db8Jeff Sharkey // other value is missing or disabled; we win 12521c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey return -1; 12622c055e6424e0e9579711545d8f4800c0f796db8Jeff Sharkey } 12722c055e6424e0e9579711545d8f4800c0f796db8Jeff Sharkey if (limitBytes == LIMIT_DISABLED || another.limitBytes < limitBytes) { 12822c055e6424e0e9579711545d8f4800c0f796db8Jeff Sharkey // we're disabled or other limit is smaller; they win 12921c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey return 1; 13021c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey } 13122c055e6424e0e9579711545d8f4800c0f796db8Jeff Sharkey return 0; 13221c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey } 13321c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 13421c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey @Override 13541ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey public int hashCode() { 1369bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey return Objects.hashCode(template, cycleDay, cycleTimezone, warningBytes, limitBytes, 1379bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey lastWarningSnooze, lastLimitSnooze, metered); 13841ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey } 13941ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey 14041ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey @Override 14141ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey public boolean equals(Object obj) { 14241ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey if (obj instanceof NetworkPolicy) { 14341ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey final NetworkPolicy other = (NetworkPolicy) obj; 144f60d0afd1ef08a24121d015bb016df05265b6d07Jeff Sharkey return cycleDay == other.cycleDay && warningBytes == other.warningBytes 1450e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey && limitBytes == other.limitBytes 1460e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey && lastWarningSnooze == other.lastWarningSnooze 1470e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey && lastLimitSnooze == other.lastLimitSnooze && metered == other.metered 1489bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey && Objects.equal(cycleTimezone, other.cycleTimezone) 1490e2e5f8b564bebd5798c9fa387fbff96429ab5d2Jeff Sharkey && Objects.equal(template, other.template); 15041ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey } 15141ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey return false; 15241ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey } 15341ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey 15441ff7ec82422a5b6d00892afdb3232bc0e53d851Jeff Sharkey @Override 15521c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey public String toString() { 1569bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey return "NetworkPolicy[" + template + "]: cycleDay=" + cycleDay + ", cycleTimezone=" 1579bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey + cycleTimezone + ", warningBytes=" + warningBytes + ", limitBytes=" + limitBytes 1589bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey + ", lastWarningSnooze=" + lastWarningSnooze + ", lastLimitSnooze=" 1599bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey + lastLimitSnooze + ", metered=" + metered; 16021c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey } 16121c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 16221c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey public static final Creator<NetworkPolicy> CREATOR = new Creator<NetworkPolicy>() { 1639bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey @Override 16421c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey public NetworkPolicy createFromParcel(Parcel in) { 16521c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey return new NetworkPolicy(in); 16621c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey } 16721c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey 1689bf3150cfae03421c9dd237b46657714859d871cJeff Sharkey @Override 16921c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey public NetworkPolicy[] newArray(int size) { 17021c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey return new NetworkPolicy[size]; 17121c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey } 17221c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey }; 17321c9c45e5caf62b935354b74392fb40c4bf18529Jeff Sharkey} 174