1 /* 2 * Copyright (C) 2012 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; 18 19 import android.net.NetworkStats; 20 import android.net.NetworkStatsHistory; 21 import android.net.NetworkTemplate; 22 23 /** {@hide} */ 24 interface INetworkStatsSession { 25 26 /** Return device aggregated network layer usage summary for traffic that matches template. */ getDeviceSummaryForNetwork(in NetworkTemplate template, long start, long end)27 NetworkStats getDeviceSummaryForNetwork(in NetworkTemplate template, long start, long end); 28 29 /** Return network layer usage summary for traffic that matches template. */ 30 @UnsupportedAppUsage getSummaryForNetwork(in NetworkTemplate template, long start, long end)31 NetworkStats getSummaryForNetwork(in NetworkTemplate template, long start, long end); 32 /** Return historical network layer stats for traffic that matches template. */ 33 @UnsupportedAppUsage getHistoryForNetwork(in NetworkTemplate template, int fields)34 NetworkStatsHistory getHistoryForNetwork(in NetworkTemplate template, int fields); 35 /** 36 * Return historical network layer stats for traffic that matches template, start and end 37 * timestamp. 38 */ getHistoryIntervalForNetwork(in NetworkTemplate template, int fields, long start, long end)39 NetworkStatsHistory getHistoryIntervalForNetwork(in NetworkTemplate template, int fields, long start, long end); 40 41 /** 42 * Return network layer usage summary per UID for traffic that matches template. 43 * 44 * <p>The resulting {@code NetworkStats#getElapsedRealtime()} contains time delta between 45 * {@code start} and {@code end}. 46 * 47 * @param template - a predicate to filter netstats. 48 * @param start - start of the range, timestamp in milliseconds since the epoch. 49 * @param end - end of the range, timestamp in milliseconds since the epoch. 50 * @param includeTags - includes data usage tags if true. 51 */ 52 @UnsupportedAppUsage getSummaryForAllUid(in NetworkTemplate template, long start, long end, boolean includeTags)53 NetworkStats getSummaryForAllUid(in NetworkTemplate template, long start, long end, boolean includeTags); 54 55 /** Return network layer usage summary per UID for tagged traffic that matches template. */ getTaggedSummaryForAllUid(in NetworkTemplate template, long start, long end)56 NetworkStats getTaggedSummaryForAllUid(in NetworkTemplate template, long start, long end); 57 58 /** Return historical network layer stats for specific UID traffic that matches template. */ 59 @UnsupportedAppUsage getHistoryForUid(in NetworkTemplate template, int uid, int set, int tag, int fields)60 NetworkStatsHistory getHistoryForUid(in NetworkTemplate template, int uid, int set, int tag, int fields); 61 /** Return historical network layer stats for specific UID traffic that matches template. */ getHistoryIntervalForUid(in NetworkTemplate template, int uid, int set, int tag, int fields, long start, long end)62 NetworkStatsHistory getHistoryIntervalForUid(in NetworkTemplate template, int uid, int set, int tag, int fields, long start, long end); 63 64 /** Return array of uids that have stats and are accessible to the calling user */ getRelevantUids()65 int[] getRelevantUids(); 66 67 @UnsupportedAppUsage close()68 void close(); 69 70 } 71