summaryrefslogtreecommitdiffstats
path: root/webkit/fileapi/media/mtp_device_map_service.h
blob: a74ce91b88226006f1e81158a09c4e634d5d2175 (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
// 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 WEBKIT_FILEAPI_MEDIA_MTP_DEVICE_MAP_SERVICE_H_
#define WEBKIT_FILEAPI_MEDIA_MTP_DEVICE_MAP_SERVICE_H_

#include <map>

#include "base/files/file_path.h"
#include "base/lazy_instance.h"
#include "base/synchronization/lock.h"
#include "base/threading/thread_checker.h"
#include "webkit/storage/webkit_storage_export.h"

namespace fileapi {

class MTPDeviceDelegate;
class MTPDeviceAsyncDelegate;

// This class provides media transfer protocol (MTP) device delegate to
// complete media file system operations. ScopedMTPDeviceMapEntry class
// manages the device map entries.
class WEBKIT_STORAGE_EXPORT MTPDeviceMapService {
 public:
  static MTPDeviceMapService* GetInstance();

  /////////////////////////////////////////////////////////////////////////////
  //   Following methods are used to manage MTPDeviceAsyncDelegate objects.  //
  /////////////////////////////////////////////////////////////////////////////
  // Adds the MTP device delegate to the map service. |device_location|
  // specifies the mount location of the MTP device.
  // Called on the IO thread.
  void AddAsyncDelegate(const base::FilePath::StringType& device_location,
                        MTPDeviceAsyncDelegate* delegate);

  // Removes the MTP device delegate from the map service. |device_location|
  // specifies the mount location of the MTP device.
  // Called on the IO thread.
  void RemoveAsyncDelegate(const base::FilePath::StringType& device_location);

  // Gets the media device delegate associated with |filesystem_id|.
  // Return NULL if the |filesystem_id| is no longer valid (e.g. because the
  // corresponding device is detached, etc).
  // Called on the IO thread.
  MTPDeviceAsyncDelegate* GetMTPDeviceAsyncDelegate(
      const std::string& filesystem_id);


  /////////////////////////////////////////////////////////////////////////////
  //  Following methods are used to manage synchronous MTPDeviceDelegate     //
  //  objects.                                                               //
  //  TODO(kmadhusu): Remove the synchronous interfaces after fixing         //
  //  crbug.com/154835                                                       //
  /////////////////////////////////////////////////////////////////////////////
  // Adds the synchronous MTP device delegate to the map service.
  // |device_location| specifies the mount location of the MTP device.
  // Called on a media task runner thread.
  void AddDelegate(const base::FilePath::StringType& device_location,
                   MTPDeviceDelegate* delegate);

  // Removes the MTP device delegate from the map service. |device_location|
  // specifies the mount location of the MTP device.
  // Called on the UI thread.
  void RemoveDelegate(const base::FilePath::StringType& device_location);

  // Gets the synchronous media device delegate associated with |filesystem_id|.
  // Return NULL if the |filesystem_id| is no longer valid (e.g. because the
  // corresponding device is detached, etc).
  // Called on a media task runner thread.
  // TODO(thestig) DCHECK AddDelegate() and GetMTPDeviceDelegate() are actually
  // called on the same task runner.
  MTPDeviceDelegate* GetMTPDeviceDelegate(const std::string& filesystem_id);

 private:
  friend struct base::DefaultLazyInstanceTraits<MTPDeviceMapService>;

  // Mapping of device_location and MTPDeviceDelegate* object. It is safe to
  // store and access the raw pointer. This class operates on the IO thread.
  typedef std::map<base::FilePath::StringType, MTPDeviceDelegate*>
      SyncDelegateMap;

  // Mapping of device_location and MTPDeviceDelegate* object. It is safe to
  // store and access the raw pointer. This class operates on the IO thread.
  typedef std::map<base::FilePath::StringType, MTPDeviceAsyncDelegate*>
      AsyncDelegateMap;

  // Get access to this class using GetInstance() method.
  MTPDeviceMapService();
  ~MTPDeviceMapService();

  /////////////////////////////////////////////////////////////////////////////
  // Following member variables are used to manage synchronous               //
  // MTP device delegate objects.                                            //
  /////////////////////////////////////////////////////////////////////////////
  // Map of attached mtp device delegates.
  SyncDelegateMap sync_delegate_map_;
  base::Lock lock_;

  /////////////////////////////////////////////////////////////////////////////
  // Following member variables are used to manage asynchronous              //
  // MTP device delegate objects.                                            //
  /////////////////////////////////////////////////////////////////////////////
  // Map of attached mtp device async delegates.
  AsyncDelegateMap async_delegate_map_;
  base::ThreadChecker thread_checker_;

  DISALLOW_COPY_AND_ASSIGN(MTPDeviceMapService);
};

}  // namespace fileapi

#endif  // WEBKIT_FILEAPI_MEDIA_MTP_DEVICE_MAP_SERVICE_H_