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
|
// 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.
// A location provider provides position information from a particular source
// (GPS, network etc). The GearsGeolocation object uses a set of location
// providers to obtain a position fix.
//
// This file declares a base class to be used by all location providers.
// Primarily, this class declares interface methods to be implemented by derived
// classes.
#ifndef CHROME_BROWSER_GEOLOCATION_LOCATION_PROVIDER_H_
#define CHROME_BROWSER_GEOLOCATION_LOCATION_PROVIDER_H_
#include <map>
#include "base/non_thread_safe.h"
#include "base/string16.h"
#include "chrome/common/geoposition.h"
class AccessTokenStore;
class GURL;
class URLRequestContextGetter;
// The base class used by all location providers.
class LocationProviderBase : public NonThreadSafe {
public:
// Clients of the location provider must implement this interface. All call-
// backs to this interface will happen in the context of the thread on which
// the location provider was created.
class ListenerInterface {
public:
// Used to inform listener that a new position fix is available or that a
// fatal error has occurred. Providers should call this for new listeners
// as soon as a position is available.
virtual void LocationUpdateAvailable(LocationProviderBase* provider) = 0;
// Used to inform listener that movement has been detected. If obtaining the
// position succeeds, this will be followed by a call to
// LocationUpdateAvailable. Some providers may not be able to detect
// movement before a new fix is obtained, so will never call this method.
// Note that this is not called in response to registration of a new
// listener.
virtual void MovementDetected(LocationProviderBase* provider) = 0;
protected:
virtual ~ListenerInterface() {}
};
virtual ~LocationProviderBase();
// Registers a listener, which will be called back on
// ListenerInterface::LocationUpdateAvailable as soon as a position is
// available and again whenever a new position is available. Ref counts the
// listener to handle multiple calls to this method.
void RegisterListener(ListenerInterface* listener);
// Unregisters a listener. Unrefs the listener to handle multiple calls to
// this method. Once the ref count reaches zero, the listener is removed and
// once this method returns, no further calls to
// ListenerInterface::LocationUpdateAvailable will be made for this listener.
// It may block if a callback is in progress.
void UnregisterListener(ListenerInterface* listener);
// Interface methods
// Returns false if the provider failed to start.
virtual bool StartProvider() = 0;
// Gets the current best position estimate.
virtual void GetPosition(Geoposition* position) = 0;
// Provides a hint to the provider that new location data is needed as soon
// as possible. Default implementation does nothing.
virtual void UpdatePosition() {}
bool has_listeners() const;
protected:
LocationProviderBase();
// Inform listeners that a new position or error is available, using
// LocationUpdateAvailable.
void UpdateListeners();
// Inform listeners that movement has been detected, using MovementDetected.
void InformListenersOfMovement();
private:
// The listeners registered to this provider. For each listener, we store a
// ref count.
typedef std::map<ListenerInterface*, int> ListenerMap;
ListenerMap listeners_;
};
// Mock implementation of a location provider for testing.
// TODO(joth): Move this and the implementation of this back in the unit_tests
// once the location_arbitrator mock/factory situation is resolved.
class MockLocationProvider : public LocationProviderBase {
public:
MockLocationProvider();
virtual ~MockLocationProvider();
using LocationProviderBase::UpdateListeners;
using LocationProviderBase::InformListenersOfMovement;
// LocationProviderBase implementation.
virtual bool StartProvider();
virtual void GetPosition(Geoposition *position);
Geoposition position_;
int started_count_;
static MockLocationProvider* instance_;
DISALLOW_COPY_AND_ASSIGN(MockLocationProvider);
};
// Factory functions for the various types of location provider to abstract over
// the platform-dependent implementations.
LocationProviderBase* NewMockLocationProvider();
LocationProviderBase* NewGpsLocationProvider();
LocationProviderBase* NewNetworkLocationProvider(
AccessTokenStore* access_token_store,
URLRequestContextGetter* context,
const GURL& url,
const string16& access_token,
const string16& host_name);
#endif // CHROME_BROWSER_GEOLOCATION_LOCATION_PROVIDER_H_
|
