blob: c955a3caf8e0caf2518647cf52e5a647ee2a8f40 (
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
|
// 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 CONTENT_BROWSER_GEOLOCATION_GEOLOCATION_PROVIDER_H_
#define CONTENT_BROWSER_GEOLOCATION_GEOLOCATION_PROVIDER_H_
#pragma once
#include <map>
#include "base/threading/thread.h"
#include "content/browser/geolocation/geolocation_observer.h"
#include "content/common/geoposition.h"
#include "googleurl/src/gurl.h"
class GeolocationArbitrator;
template<typename Type>
struct DefaultSingletonTraits;
// This is the main API to the geolocaiton subsystem. The application
// will hold a single instance of this class, and can register multiple
// observers which will be notified of location updates. Underlying location
// arbitrator will only be enabled whilst there is at least one observer
// registered.
class GeolocationProvider : public base::Thread, public GeolocationObserver {
public:
GeolocationProvider();
// Must be called from the same thread as the GeolocationProvider was created
// on. The GeolocationObserverOptions passed are used as a 'hint' for the
// provider preferences for this particular observer, however the observer
// could receive callbacks for best available locations from any active
// provider whilst it is registered.
// If an existing observer is added a second time it's options are updated
// but only a single call to RemoveObserver() is required to remove it.
void AddObserver(GeolocationObserver* delegate,
const GeolocationObserverOptions& update_options);
// Remove a previously registered observer. No-op if not previously registered
// via AddObserver(). Returns true if the observer was removed.
bool RemoveObserver(GeolocationObserver* delegate);
void OnPermissionGranted(const GURL& requesting_frame);
bool HasPermissionBeenGranted() const;
// GeolocationObserver
virtual void OnLocationUpdate(const Geoposition& position);
// Gets a pointer to the singleton instance of the location relayer, which
// is in turn bound to the browser's global context objects. Ownership is NOT
// returned.
static GeolocationProvider* GetInstance();
typedef std::map<GeolocationObserver*, GeolocationObserverOptions>
ObserverMap;
private:
friend struct DefaultSingletonTraits<GeolocationProvider>;
virtual ~GeolocationProvider();
bool OnClientThread() const;
bool OnGeolocationThread() const;
// When the observer list changes, we may start the thread and the required
// providers, or stop them.
void OnObserversChanged();
// Stop the providers when there are no more observers. Note that once our
// thread is started, we'll keep it alive (but with no pending messages).
void StopProviders();
// Starts or updates the observers' geolocation options
// (delegates to arbitrator).
void StartProviders(const GeolocationObserverOptions& options);
// Update the providers on the geolocation thread, which must be running.
void InformProvidersPermissionGranted(const GURL& requesting_frame);
// Notifies observers when a new position fix is available.
void NotifyObservers(const Geoposition& position);
// Thread
virtual void Init();
virtual void CleanUp();
scoped_refptr<base::MessageLoopProxy> client_loop_;
// Only used on client thread
ObserverMap observers_;
GURL most_recent_authorized_frame_;
Geoposition position_;
// Only to be used on the geolocation thread.
GeolocationArbitrator* arbitrator_;
DISALLOW_COPY_AND_ASSIGN(GeolocationProvider);
};
#endif // CONTENT_BROWSER_GEOLOCATION_GEOLOCATION_PROVIDER_H_
|
