removable_storage_dev.h

Go to the documentation of this file.

/** <!-- -*- c++ -*- ****************************************************** -->
 *
 *  @file  removable_storage_dev.h
 *  @author  Michal Jurkiewicz <m.jurkiewicz@samsung.com>
 *  @date  11-10-2013
 *
 ******************************************************************************
 *
 * Copyright (c) 2013 Samsung Electronics, Visual Display Division.
 * All Rights Reserved.
 *
 * This software is the confidential and proprietary information
 * of Samsung Electronics, Inc. ("Confidential Information").  You
 * shall not disclose such Confidential Information and shall use
 * it only in accordance with the terms of the license agreement
 * you entered into with Samsung.
 *
 *****************************************************************************/

#ifndef PPAPI_CPP_REMOVABLE_STORAGE_DEV_H_
#define PPAPI_CPP_REMOVABLE_STORAGE_DEV_H_

#include "ppapi/c/dev/ppb_removable_storage_dev.h"
#include "ppapi/cpp/completion_callback.h"
#include "ppapi/cpp/dev/device_ref_dev.h"
#include "ppapi/cpp/file_system.h"
#include "ppapi/cpp/instance_handle.h"
#include "ppapi/cpp/resource.h"


namespace pp {

class RemovableStorage_Dev : public Resource {
public:

  /**
   * Creates a removable storage resource.
   *
   * @param[in] instance A <code>InstanceHandle</code> identifying one instance of
   * a module.
   *
   * @return A <code>Resource</code> corresponding to a removable storage
   * resource if successful, 0 if failed.
   */

  explicit RemovableStorage_Dev(const InstanceHandle& instance);

  /**
   * Determines if the given resource is a removable storage resource.
   *
   * @return A <code>bool</code> containing <code>true</code> if the given
   * resource is a removable storage resource, otherwise <code>false</code>.
   */

  bool IsRemovableStorage();

  /**
   * Determines if the given resource is available.
   *
   * @return A <code>bool</code> containing <code>true</code> if the given
   * resource is available, otherwise <code>false</code>.
   */

  static bool IsAvailable();

  /**
   * Enumerates removable storage devices.
   *
   * @param[in] callback A <code>CompletionCallbackWithOutput</code> to run on
   * completion.
   *
   * @return An error code from <code>pp_errors.h</code>.
   */

  int32_t EnumerateDevices(const CompletionCallbackWithOutput<std::vector<DeviceRef_Dev> >& callback);

  /**
   * Requests device change notifications.
   *
   * @param[in] callback The callback to receive notifications. If not NULL, it
   * will be called once for the currently available devices, and then every
   * time the list of available devices changes. All calls will happen on the
   * same thread as the one on which MonitorDeviceChange() is called. It will
   * receive notifications until it will be destroyed or
   * <code>MonitorDeviceChange()</code> is called to set a new callback for
   * <code>removable_storage</code>. You can pass NULL to cancel sending
   * notifications.
   * @param[inout] user_data An opaque pointer that will be passed to
   * <code>callback</code>.
   *
   * @return An error code from <code>pp_errors.h</code>.
   */

  int32_t MonitorDeviceChange(PP_MonitorDeviceChangeCallback callback,
    void* user_data);

  /**
   * Opens removable file system.
   *
   * @param[in] file_system A <code>FileSystem</code> corresponding to a file
   * system of PP_FILESYSTEMTYPE_REMOVABLESTORAGE type.
   * @param[in] device_ref A <code>DeviceRef_Dev</code> corresponding to a device
   * reference.
   * @param[in] callback A <code>CompletionCallback</code> to run on
   * completion.
   *
   * @return An error code from <code>pp_errors.h</code>.
   */

  int32_t Open(const FileSystem& file_system,
    const DeviceRef_Dev& device_ref,
    const CompletionCallback& callback);
};

}  // namespace pp

#endif  // PPAPI_CPP_REMOVABLE_STORAGE_DEV_H_