BaseNetworkStateTracker.java revision c5fd6e59db10bb0069cf64394dce3955234757c1 
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
17package android.net;
18
19import android.content.Context;
20import android.os.Handler;
21
22import com.android.internal.util.Preconditions;
23
24import java.util.concurrent.atomic.AtomicBoolean;
25
26/**
27 * Interface to control and observe state of a specific network, hiding
28 * network-specific details from {@link ConnectivityManager}. Surfaces events
29 * through the registered {@link Handler} to enable {@link ConnectivityManager}
30 * to respond to state changes over time.
31 *
32 * @hide
33 */
34public abstract class BaseNetworkStateTracker implements NetworkStateTracker {
35    // TODO: better document threading expectations
36    // TODO: migrate to make NetworkStateTracker abstract class
37
38    public static final String PROP_TCP_BUFFER_UNKNOWN = "net.tcp.buffersize.unknown";
39    public static final String PROP_TCP_BUFFER_WIFI = "net.tcp.buffersize.wifi";
40
41    protected Context mContext;
42    private Handler mTarget;
43
44    protected NetworkInfo mNetworkInfo;
45    protected LinkProperties mLinkProperties;
46    protected LinkCapabilities mLinkCapabilities;
47
48    private AtomicBoolean mTeardownRequested = new AtomicBoolean(false);
49    private AtomicBoolean mPrivateDnsRouteSet = new AtomicBoolean(false);
50    private AtomicBoolean mDefaultRouteSet = new AtomicBoolean(false);
51
52    public BaseNetworkStateTracker(int networkType) {
53        mNetworkInfo = new NetworkInfo(
54                networkType, -1, ConnectivityManager.getNetworkTypeName(networkType), null);
55        mLinkProperties = new LinkProperties();
56        mLinkCapabilities = new LinkCapabilities();
57    }
58
59    @Deprecated
60    protected Handler getTargetHandler() {
61        return mTarget;
62    }
63
64    protected final void dispatchStateChanged() {
65        // TODO: include snapshot of other fields when sending
66        mTarget.obtainMessage(EVENT_STATE_CHANGED, getNetworkInfo()).sendToTarget();
67    }
68
69    protected final void dispatchConfigurationChanged() {
70        // TODO: include snapshot of other fields when sending
71        mTarget.obtainMessage(EVENT_CONFIGURATION_CHANGED, getNetworkInfo()).sendToTarget();
72    }
73
74    @Override
75    public final void startMonitoring(Context context, Handler target) {
76        mContext = Preconditions.checkNotNull(context);
77        mTarget = Preconditions.checkNotNull(target);
78        startMonitoringInternal();
79    }
80
81    protected abstract void startMonitoringInternal();
82
83    @Override
84    public final NetworkInfo getNetworkInfo() {
85        return new NetworkInfo(mNetworkInfo);
86    }
87
88    @Override
89    public final LinkProperties getLinkProperties() {
90        return new LinkProperties(mLinkProperties);
91    }
92
93    @Override
94    public final LinkCapabilities getLinkCapabilities() {
95        return new LinkCapabilities(mLinkCapabilities);
96    }
97
98    @Override
99    public void captivePortalCheckComplete() {
100        // not implemented
101    }
102
103    @Override
104    public boolean setRadio(boolean turnOn) {
105        // Base tracker doesn't handle radios
106        return true;
107    }
108
109    @Override
110    public boolean isAvailable() {
111        return mNetworkInfo.isAvailable();
112    }
113
114    @Override
115    public void setUserDataEnable(boolean enabled) {
116        // Base tracker doesn't handle enabled flags
117    }
118
119    @Override
120    public void setPolicyDataEnable(boolean enabled) {
121        // Base tracker doesn't handle enabled flags
122    }
123
124    @Override
125    public boolean isPrivateDnsRouteSet() {
126        return mPrivateDnsRouteSet.get();
127    }
128
129    @Override
130    public void privateDnsRouteSet(boolean enabled) {
131        mPrivateDnsRouteSet.set(enabled);
132    }
133
134    @Override
135    public boolean isDefaultRouteSet() {
136        return mDefaultRouteSet.get();
137    }
138
139    @Override
140    public void defaultRouteSet(boolean enabled) {
141        mDefaultRouteSet.set(enabled);
142    }
143
144    @Override
145    public boolean isTeardownRequested() {
146        return mTeardownRequested.get();
147    }
148
149    @Override
150    public void setTeardownRequested(boolean isRequested) {
151        mTeardownRequested.set(isRequested);
152    }
153
154    @Override
155    public void setDependencyMet(boolean met) {
156        // Base tracker doesn't handle dependencies
157    }
158}
159