blob: 5f0ee0ae780c57250e59ef4da3124f5ceb885bd2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_GEOLOCATION_WIFI_DATA_PROVIDER_COMMON_H_
#define CHROME_BROWSER_GEOLOCATION_WIFI_DATA_PROVIDER_COMMON_H_
#pragma once
#include <assert.h>
#include "base/logging.h"
#include "base/scoped_ptr.h"
#include "base/string16.h"
#include "base/task.h"
#include "base/thread.h"
#include "chrome/browser/geolocation/device_data_provider.h"
// Converts a MAC address stored as an array of uint8 to a string.
string16 MacAddressAsString16(const uint8 mac_as_int[6]);
// Allows sharing and mocking of the update polling policy function.
class PollingPolicyInterface {
public:
virtual ~PollingPolicyInterface() {}
// Calculates the new polling interval for wiFi scans, given the previous
// interval and whether the last scan produced new results.
virtual void UpdatePollingInterval(bool scan_results_differ) = 0;
virtual int PollingInterval() = 0;
virtual int NoWifiInterval() = 0;
};
// Generic polling policy, constants are compile-time parameterized to allow
// tuning on a per-platform basis.
template<int DEFAULT_INTERVAL,
int NO_CHANGE_INTERVAL,
int TWO_NO_CHANGE_INTERVAL,
int NO_WIFI_INTERVAL>
class GenericPollingPolicy : public PollingPolicyInterface {
public:
GenericPollingPolicy() : polling_interval_(DEFAULT_INTERVAL) {}
// PollingPolicyInterface
virtual void UpdatePollingInterval(bool scan_results_differ) {
if (scan_results_differ) {
polling_interval_ = DEFAULT_INTERVAL;
} else if (polling_interval_ == DEFAULT_INTERVAL) {
polling_interval_ = NO_CHANGE_INTERVAL;
} else {
DCHECK(polling_interval_ == NO_CHANGE_INTERVAL ||
polling_interval_ == TWO_NO_CHANGE_INTERVAL);
polling_interval_ = TWO_NO_CHANGE_INTERVAL;
}
}
virtual int PollingInterval() { return polling_interval_; }
virtual int NoWifiInterval() { return NO_WIFI_INTERVAL; }
private:
int polling_interval_;
};
// Base class to promote code sharing between platform specific wifi data
// providers. It's optional for specific platforms to derive this, but if they
// do threading and polling is taken care of by this base class, and all the
// platform need do is provide the underlying WLAN access API and policy policy,
// both of which will be create & accessed in the worker thread (only).
// Also designed this way to promotes ease of testing the cross-platform
// behavior w.r.t. polling & threading.
class WifiDataProviderCommon
: public WifiDataProviderImplBase,
private base::Thread {
public:
// Interface to abstract the low level data OS library call, and to allow
// mocking (hence public).
class WlanApiInterface {
public:
virtual ~WlanApiInterface() {}
// Gets wifi data for all visible access points.
virtual bool GetAccessPointData(WifiData::AccessPointDataSet* data) = 0;
};
WifiDataProviderCommon();
// WifiDataProviderImplBase implementation
virtual bool StartDataProvider();
virtual void StopDataProvider();
virtual bool GetData(WifiData *data);
protected:
virtual ~WifiDataProviderCommon();
// Returns ownership. Will be called from the worker thread.
virtual WlanApiInterface* NewWlanApi() = 0;
// Returns ownership. Will be called from the worker thread.
virtual PollingPolicyInterface* NewPollingPolicy() = 0;
private:
// Thread implementation
virtual void Init();
virtual void CleanUp();
// Task which run in the child thread.
void DoWifiScanTask();
// Will schedule a scan; i.e. enqueue DoWifiScanTask deferred task.
void ScheduleNextScan(int interval);
WifiData wifi_data_;
Lock data_mutex_;
// Whether we've successfully completed a scan for WiFi data (or the polling
// thread has terminated early).
bool is_first_scan_complete_;
// Underlying OS wifi API.
scoped_ptr<WlanApiInterface> wlan_api_;
// Controls the polling update interval.
scoped_ptr<PollingPolicyInterface> polling_policy_;
// Holder for the tasks which run on the thread; takes care of cleanup.
ScopedRunnableMethodFactory<WifiDataProviderCommon> task_factory_;
DISALLOW_COPY_AND_ASSIGN(WifiDataProviderCommon);
};
#endif // CHROME_BROWSER_GEOLOCATION_WIFI_DATA_PROVIDER_COMMON_H_
|
