1e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian/* 2e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * Copyright (C) 2010 The Android Open Source Project 3e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * 4e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * Licensed under the Apache License, Version 2.0 (the "License"); 5e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * you may not use this file except in compliance with the License. 6e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * You may obtain a copy of the License at 7e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * 8e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * http://www.apache.org/licenses/LICENSE-2.0 9e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * 10e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * Unless required by applicable law or agreed to in writing, software 11e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * distributed under the License is distributed on an "AS IS" BASIS, 12e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * See the License for the specific language governing permissions and 14e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * limitations under the License. 15e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 16e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 17e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 18e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian#ifndef ANDROID_STORAGE_MANAGER_H 19e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian#define ANDROID_STORAGE_MANAGER_H 20e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 21e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian#include <stdint.h> 22e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 23e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian#ifdef __cplusplus 24e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopianextern "C" { 25e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian#endif 26e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 27e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopianstruct AStorageManager; 28e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopiantypedef struct AStorageManager AStorageManager; 29e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 30e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopianenum { 31e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian /* 32e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * The OBB container is now mounted and ready for use. Can be returned 33e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * as the status for callbacks made during asynchronous OBB actions. 34e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 35e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian AOBB_STATE_MOUNTED = 1, 36e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 37e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian /* 38e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * The OBB container is now unmounted and not usable. Can be returned 39e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * as the status for callbacks made during asynchronous OBB actions. 40e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 41e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian AOBB_STATE_UNMOUNTED = 2, 42e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 43e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian /* 44e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * There was an internal system error encountered while trying to 45e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * mount the OBB. Can be returned as the status for callbacks made 46e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * during asynchronous OBB actions. 47e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 48e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian AOBB_STATE_ERROR_INTERNAL = 20, 49e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 50e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian /* 51e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * The OBB could not be mounted by the system. Can be returned as the 52e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * status for callbacks made during asynchronous OBB actions. 53e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 54e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian AOBB_STATE_ERROR_COULD_NOT_MOUNT = 21, 55e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 56e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian /* 57e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * The OBB could not be unmounted. This most likely indicates that a 58e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * file is in use on the OBB. Can be returned as the status for 59e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * callbacks made during asynchronous OBB actions. 60e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 61e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian AOBB_STATE_ERROR_COULD_NOT_UNMOUNT = 22, 62e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 63e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian /* 64e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * A call was made to unmount the OBB when it was not mounted. Can be 65e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * returned as the status for callbacks made during asynchronous OBB 66e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * actions. 67e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 68e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian AOBB_STATE_ERROR_NOT_MOUNTED = 23, 69e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 70e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian /* 71e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * The OBB has already been mounted. Can be returned as the status for 72e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * callbacks made during asynchronous OBB actions. 73e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 74e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian AOBB_STATE_ERROR_ALREADY_MOUNTED = 24, 75e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 76e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian /* 77e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * The current application does not have permission to use this OBB. 78e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * This could be because the OBB indicates it's owned by a different 79e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * package. Can be returned as the status for callbacks made during 80e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * asynchronous OBB actions. 81e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 82e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian AOBB_STATE_ERROR_PERMISSION_DENIED = 25, 83e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian}; 84e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 85e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian/** 86e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * Obtains a new instance of AStorageManager. 87e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 88e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias AgopianAStorageManager* AStorageManager_new(); 89e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 90e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian/** 91e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * Release AStorageManager instance. 92e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 93e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopianvoid AStorageManager_delete(AStorageManager* mgr); 94e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 95e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian/** 96e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * Callback function for asynchronous calls made on OBB files. 97e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 98e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopiantypedef void (*AStorageManager_obbCallbackFunc)(const char* filename, const int32_t state, void* data); 99e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 100e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian/** 101e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * Attempts to mount an OBB file. This is an asynchronous operation. 102e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 103e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopianvoid AStorageManager_mountObb(AStorageManager* mgr, const char* filename, const char* key, 104e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian AStorageManager_obbCallbackFunc cb, void* data); 105e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 106e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian/** 107e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * Attempts to unmount an OBB file. This is an asynchronous operation. 108e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 109e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopianvoid AStorageManager_unmountObb(AStorageManager* mgr, const char* filename, const int force, 110e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian AStorageManager_obbCallbackFunc cb, void* data); 111e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 112e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian/** 113e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * Check whether an OBB is mounted. 114e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 115e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopianint AStorageManager_isObbMounted(AStorageManager* mgr, const char* filename); 116e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 117e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian/** 118e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian * Get the mounted path for an OBB. 119e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian */ 120e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopianconst char* AStorageManager_getMountedObbPath(AStorageManager* mgr, const char* filename); 121e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 122e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 123e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian#ifdef __cplusplus 124e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian}; 125e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian#endif 126e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian 127e1c61d3cc8458ce9a15d8109f728e60f5248939dMathias Agopian#endif // ANDROID_STORAGE_MANAGER_H 128