diff options
Diffstat (limited to 'device/media_transfer_protocol/media_transfer_protocol_daemon_client.h')
| -rw-r--r-- | device/media_transfer_protocol/media_transfer_protocol_daemon_client.h | 180 |
1 files changed, 180 insertions, 0 deletions
diff --git a/device/media_transfer_protocol/media_transfer_protocol_daemon_client.h b/device/media_transfer_protocol/media_transfer_protocol_daemon_client.h new file mode 100644 index 0000000..bba9794 --- /dev/null +++ b/device/media_transfer_protocol/media_transfer_protocol_daemon_client.h @@ -0,0 +1,180 @@ +// 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. + +// Client code to talk to the Media Transfer Protocol daemon. The MTP daemon is +// responsible for communicating with PTP / MTP capable devices like cameras +// and smartphones. + +#ifndef DEVICE_MEDIA_TRANSFER_PROTOCOL_MEDIA_TRANSFER_PROTOCOL_DAEMON_CLIENT_H_ +#define DEVICE_MEDIA_TRANSFER_PROTOCOL_MEDIA_TRANSFER_PROTOCOL_DAEMON_CLIENT_H_ + +#include <string> +#include <vector> + +#include "base/basictypes.h" +#include "base/callback.h" +#include "build/build_config.h" + +#if !defined(OS_LINUX) +#error "Only used on Linux and ChromeOS" +#endif + +class MtpFileEntry; +class MtpStorageInfo; + +namespace dbus { +class Bus; +} + +namespace device { + +// A class to make the actual DBus calls for mtpd service. +// This class only makes calls, result/error handling should be done +// by callbacks. +class MediaTransferProtocolDaemonClient { + public: + // A callback to be called when DBus method call fails. + typedef base::Callback<void()> ErrorCallback; + + // A callback to handle the result of EnumerateAutoMountableDevices. + // The argument is the enumerated storage names. + typedef base::Callback<void(const std::vector<std::string>& storage_names) + > EnumerateStoragesCallback; + + // A callback to handle the result of GetStorageInfo. + // The argument is the information about the specified storage. + typedef base::Callback<void(const MtpStorageInfo& storage_info) + > GetStorageInfoCallback; + + // A callback to handle the result of OpenStorage. + // The argument is the returned handle. + typedef base::Callback<void(const std::string& handle)> OpenStorageCallback; + + // A callback to handle the result of CloseStorage. + typedef base::Callback<void()> CloseStorageCallback; + + // A callback to handle the result of ReadDirectoryByPath/Id. + // The argument is a vector of file entries. + typedef base::Callback<void(const std::vector<MtpFileEntry>& file_entries) + > ReadDirectoryCallback; + + // A callback to handle the result of ReadFileChunkByPath/Id. + // The argument is a string containing the file data. + typedef base::Callback<void(const std::string& data)> ReadFileCallback; + + // A callback to handle the result of GetFileInfoByPath/Id. + // The argument is a file entry. + typedef base::Callback<void(const MtpFileEntry& file_entry) + > GetFileInfoCallback; + + // A callback to handle storage attach/detach events. + // The first argument is true for attach, false for detach. + // The second argument is the storage name. + typedef base::Callback<void(bool is_attach, + const std::string& storage_name) + > MTPStorageEventHandler; + + virtual ~MediaTransferProtocolDaemonClient(); + + // Calls EnumerateStorages method. |callback| is called after the + // method call succeeds, otherwise, |error_callback| is called. + virtual void EnumerateStorages( + const EnumerateStoragesCallback& callback, + const ErrorCallback& error_callback) = 0; + + // Calls GetStorageInfo method. |callback| is called after the method call + // succeeds, otherwise, |error_callback| is called. + virtual void GetStorageInfo(const std::string& storage_name, + const GetStorageInfoCallback& callback, + const ErrorCallback& error_callback) = 0; + + // Calls OpenStorage method. |callback| is called after the method call + // succeeds, otherwise, |error_callback| is called. + // OpenStorage returns a handle in |callback|. + virtual void OpenStorage(const std::string& storage_name, + const std::string& mode, + const OpenStorageCallback& callback, + const ErrorCallback& error_callback) = 0; + + // Calls CloseStorage method. |callback| is called after the method call + // succeeds, otherwise, |error_callback| is called. + // |handle| comes from a OpenStorageCallback. + virtual void CloseStorage(const std::string& handle, + const CloseStorageCallback& callback, + const ErrorCallback& error_callback) = 0; + + // Calls ReadDirectoryByPath method. |callback| is called after the method + // call succeeds, otherwise, |error_callback| is called. + virtual void ReadDirectoryByPath(const std::string& handle, + const std::string& path, + const ReadDirectoryCallback& callback, + const ErrorCallback& error_callback) = 0; + + // Calls ReadDirectoryById method. |callback| is called after the method + // call succeeds, otherwise, |error_callback| is called. + // |file_id| is a MTP-device specific id for a file. + virtual void ReadDirectoryById(const std::string& handle, + uint32 file_id, + const ReadDirectoryCallback& callback, + const ErrorCallback& error_callback) = 0; + + // Calls ReadFileChunkByPath method. |callback| is called after the method + // call succeeds, otherwise, |error_callback| is called. + // |bytes_to_read| cannot exceed 1 MiB. + virtual void ReadFileChunkByPath(const std::string& handle, + const std::string& path, + uint32 offset, + uint32 bytes_to_read, + const ReadFileCallback& callback, + const ErrorCallback& error_callback) = 0; + + // TODO(thestig) Remove this in the near future if we don't see anyone using + // it. + // Calls ReadFilePathById method. |callback| is called after the method call + // succeeds, otherwise, |error_callback| is called. + // |file_id| is a MTP-device specific id for a file. + // |bytes_to_read| cannot exceed 1 MiB. + virtual void ReadFileChunkById(const std::string& handle, + uint32 file_id, + uint32 offset, + uint32 bytes_to_read, + const ReadFileCallback& callback, + const ErrorCallback& error_callback) = 0; + + // Calls GetFileInfoByPath method. |callback| is called after the method + // call succeeds, otherwise, |error_callback| is called. + virtual void GetFileInfoByPath(const std::string& handle, + const std::string& path, + const GetFileInfoCallback& callback, + const ErrorCallback& error_callback) = 0; + + // Calls GetFileInfoById method. |callback| is called after the method + // call succeeds, otherwise, |error_callback| is called. + // |file_id| is a MTP-device specific id for a file. + virtual void GetFileInfoById(const std::string& handle, + uint32 file_id, + const GetFileInfoCallback& callback, + const ErrorCallback& error_callback) = 0; + + // Registers given callback for events. + // |storage_event_handler| is called when a mtp storage attach or detach + // signal is received. + virtual void SetUpConnections(const MTPStorageEventHandler& handler) = 0; + + // Factory function, creates a new instance and returns ownership. + // For normal usage, set |is_stub| to false. + static MediaTransferProtocolDaemonClient* Create(dbus::Bus* bus, + bool is_stub); + + protected: + // Create() should be used instead. + MediaTransferProtocolDaemonClient(); + + private: + DISALLOW_COPY_AND_ASSIGN(MediaTransferProtocolDaemonClient); +}; + +} // namespace device + +#endif // DEVICE_MEDIA_TRANSFER_PROTOCOL_MEDIA_TRANSFER_PROTOCOL_DAEMON_CLIENT_H_ |