summaryrefslogtreecommitdiffstats
path: root/content/public/browser/sensors_provider.h
blob: 32da1f2cd3a0d18229d491c7c04071a5aed278e0 (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
// Copyright (c) 2012 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_PUBLIC_BROWSER_SENSORS_PROVIDER_H_
#define CONTENT_PUBLIC_BROWSER_SENSORS_PROVIDER_H_
#pragma once

#include "content/common/content_export.h"
#include "content/public/browser/sensors.h"

// The sensors API will unify various types of sensor data into a set of
// channels, each of which provides change events and periodic updates.
//
// This version of the API is intended only to support the experimental screen
// rotation code and is not for general use. In particular, the final listener
// will declare generic |OnSensorChanged| and |OnSensorUpdated| methods, rather
// than the special-purpose |OnScreenOrientationChanged|.

namespace content {

class SensorsListener;

// TODO(cwolfe): Finish defining the initial set of channels and replace this
// with the generic sensor provider.
class SensorsProvider {
 public:
  CONTENT_EXPORT static SensorsProvider* GetInstance();

  // Adds a sensor listener. The listener will receive callbacks to indicate
  // sensor changes and updates until it is removed.
  //
  // This method may be called in any thread. Callbacks on a listener will
  // always be executed in the thread which added that listener.
  virtual void AddListener(SensorsListener* listener) = 0;

  // Removes a sensor listener.
  //
  // This method must be called in the same thread which added the listener.
  // If the listener is not currently subscribed, this method may be called in
  // any thread.
  virtual void RemoveListener(SensorsListener* listener) = 0;

  // Broadcasts a change to the coarse screen orientation.
  //
  // This method may be called in any thread.
  virtual void ScreenOrientationChanged(ScreenOrientation change) = 0;

 protected:
  virtual ~SensorsProvider() {}
};

}  // namespace content

#endif  // CONTENT_PUBLIC_BROWSER_SENSORS_PROVIDER_H_