inc/FIoIMmcStorageMountListener.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18 * @file         FIoIMmcStorageMountListener.h
  19 * @brief        This is the header file for the %IMmcStorageMountListener interface.
  20 *
  21 * This header file contains the declarations of the %IMmcStorageMountListener interface.
  22 */
  23
  24 #ifndef _FIO_IMMC_STORAGE_MOUNT_LISTENER_H_
  25 #define _FIO_IMMC_STORAGE_MOUNT_LISTENER_H_
  26
  27 #include <FBaseRtIEventListener.h>
  28
  29 namespace Tizen { namespace Io
  30 {
  31
  32 /**
  33 * @interface    IMmcStorageMountListener
  34 * @brief                This interface is the listener to receive the result of external MMC mount or unmount operations.
  35 * @since                2.0
  36 *
  37 * The %IMmcStorageMountListener interface must be registered and implemented by an application to receive the result of
  38 * external MMC mount or unmount operations.
  39 *
  40 * @see MmcStorageManager
  41 */
  42 class _OSP_EXPORT_ IMmcStorageMountListener
  43            : public virtual Tizen::Base::Runtime::IEventListener
  44 {
  45 public:
  46         /**
  47         * This polymorphic destructor should be overridden if required. @n
  48         * This way, the destructors of the derived classes are called when the destructor of this interface called.
  49         *
  50         * @since        2.0
  51         */
  52         virtual ~IMmcStorageMountListener(void) {}
  53
  54         /**
  55         * Called when the external MMC mount operation is completed.
  56         *
  57         * @since                2.0
  58         *
  59         * @param[in]    r                               The result of external MMC mount operation
  60         * @exception    E_SUCCESS               The mount operation is successful.
  61         * @exception    E_IO                    Either of the following conditions has occurred:
  62         *                                                               - The file system to be mounted has an invalid superblock.
  63         *                                                               - An unexpected device failure has occurred as the media ejected suddenly.
  64         * @exception     E_SYSTEM               The method cannot proceed due to a severe system error.
  65         */
  66         virtual void OnMmcStorageMounted(result r) = 0;
  67
  68         /**
  69         * Called when external MMC unmount operation is completed.
  70         *
  71         * @since                2.0
  72         *
  73         * @param[in]    r                               The result of external MMC unmount operation
  74         * @exception    E_SUCCESS               The unmount operation is successful.
  75         * @exception    E_IO                    An unexpected device failure has occurred as the media ejected suddenly.
  76         * @exception    E_SYSTEM                The method cannot proceed due to a severe system error.
  77         */
  78         virtual void OnMmcStorageUnmounted(result r) = 0;
  79
  80 protected:
  81         //
  82         // This method is for internal use only.
  83         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  84         //
  85         // @since 2.0
  86         virtual void IMmcStorageMountListener_Reserved1(void) {}
  87
  88         //
  89         // This method is for internal use only.
  90         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  91         //
  92         // @since 2.0
  93         virtual void IMmcStorageMountListener_Reserved2(void) {}
  94
  95         //
  96         // This method is for internal use only.
  97         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  98         //
  99         // @since 2.0
 100         virtual void IMmcStorageMountListener_Reserved3(void) {}
 101
 102 }; // IMmcStorageMountListener
 103
 104 } } // Tizen::Io
 105
 106 #endif // _FIO_IMMC_STORAGE_MOUNT_LISTENER_H