page.title=Storage page.customHeadTag= @jd:body
Files | Typedefs | Enumerations | Functions
Storage

Files

file  obb.h
 
file  storage_manager.h
 

Typedefs

typedef struct AObbInfo AObbInfo
 
typedef struct AStorageManager AStorageManager
 
typedef void(* AStorageManager_obbCallbackFunc )(const char *filename, const int32_t state, void *data)
 

Enumerations

enum  { AOBBINFO_OVERLAY = 0x0001 }
 
enum  {
  AOBB_STATE_MOUNTED = 1, AOBB_STATE_UNMOUNTED = 2, AOBB_STATE_ERROR_INTERNAL = 20, AOBB_STATE_ERROR_COULD_NOT_MOUNT = 21,
  AOBB_STATE_ERROR_COULD_NOT_UNMOUNT = 22, AOBB_STATE_ERROR_NOT_MOUNTED = 23, AOBB_STATE_ERROR_ALREADY_MOUNTED = 24, AOBB_STATE_ERROR_PERMISSION_DENIED = 25
}
 

Functions

AObbInfo * AObbScanner_getObbInfo (const char *filename)
 
void AObbInfo_delete (AObbInfo *obbInfo)
 
const char * AObbInfo_getPackageName (AObbInfo *obbInfo)
 
int32_t AObbInfo_getVersion (AObbInfo *obbInfo)
 
int32_t AObbInfo_getFlags (AObbInfo *obbInfo)
 
AStorageManager * AStorageManager_new ()
 
void AStorageManager_delete (AStorageManager *mgr)
 
void AStorageManager_mountObb (AStorageManager *mgr, const char *filename, const char *key, AStorageManager_obbCallbackFunc cb, void *data)
 
void AStorageManager_unmountObb (AStorageManager *mgr, const char *filename, const int force, AStorageManager_obbCallbackFunc cb, void *data)
 
int AStorageManager_isObbMounted (AStorageManager *mgr, const char *filename)
 
const char * AStorageManager_getMountedObbPath (AStorageManager *mgr, const char *filename)
 

Detailed Description

Typedef Documentation

typedef struct AObbInfo AObbInfo

AObbInfo is an opaque type representing information for obb storage.

typedef struct AStorageManager AStorageManager

AStorageManager manages application OBB storage, a pointer can be obtained with AStorageManager_new().

typedef void(* AStorageManager_obbCallbackFunc)(const char *filename, const int32_t state, void *data)

Callback function for asynchronous calls made on OBB files.

"state" is one of the following constants:

Enumeration Type Documentation

anonymous enum

Flag for an obb file, returned by AObbInfo_getFlags().

Enumerator
AOBBINFO_OVERLAY 

overlay

anonymous enum

The different states of a OBB storage passed to AStorageManager_obbCallbackFunc().

Enumerator
AOBB_STATE_MOUNTED 

The OBB container is now mounted and ready for use. Can be returned as the status for callbacks made during asynchronous OBB actions.

AOBB_STATE_UNMOUNTED 

The OBB container is now unmounted and not usable. Can be returned as the status for callbacks made during asynchronous OBB actions.

AOBB_STATE_ERROR_INTERNAL 

There was an internal system error encountered while trying to mount the OBB. Can be returned as the status for callbacks made during asynchronous OBB actions.

AOBB_STATE_ERROR_COULD_NOT_MOUNT 

The OBB could not be mounted by the system. Can be returned as the status for callbacks made during asynchronous OBB actions.

AOBB_STATE_ERROR_COULD_NOT_UNMOUNT 

The OBB could not be unmounted. This most likely indicates that a file is in use on the OBB. Can be returned as the status for callbacks made during asynchronous OBB actions.

AOBB_STATE_ERROR_NOT_MOUNTED 

A call was made to unmount the OBB when it was not mounted. Can be returned as the status for callbacks made during asynchronous OBB actions.

AOBB_STATE_ERROR_ALREADY_MOUNTED 

The OBB has already been mounted. Can be returned as the status for callbacks made during asynchronous OBB actions.

AOBB_STATE_ERROR_PERMISSION_DENIED 

The current application does not have permission to use this OBB. This could be because the OBB indicates it's owned by a different package. Can be returned as the status for callbacks made during asynchronous OBB actions.

Function Documentation

void AObbInfo_delete ( AObbInfo *  obbInfo)

Destroy the AObbInfo object. You must call this when finished with the object.

int32_t AObbInfo_getFlags ( AObbInfo *  obbInfo)

Get the flags of an OBB file.

const char* AObbInfo_getPackageName ( AObbInfo *  obbInfo)

Get the package name for the OBB.

int32_t AObbInfo_getVersion ( AObbInfo *  obbInfo)

Get the version of an OBB file.

AObbInfo* AObbScanner_getObbInfo ( const char *  filename)

Scan an OBB and get information about it.

void AStorageManager_delete ( AStorageManager *  mgr)

Release AStorageManager instance.

const char* AStorageManager_getMountedObbPath ( AStorageManager *  mgr,
const char *  filename 
)

Get the mounted path for an OBB.

int AStorageManager_isObbMounted ( AStorageManager *  mgr,
const char *  filename 
)

Check whether an OBB is mounted.

void AStorageManager_mountObb ( AStorageManager *  mgr,
const char *  filename,
const char *  key,
AStorageManager_obbCallbackFunc  cb,
void *  data 
)

Attempts to mount an OBB file. This is an asynchronous operation.

AStorageManager* AStorageManager_new ( )

Obtains a new instance of AStorageManager.

void AStorageManager_unmountObb ( AStorageManager *  mgr,
const char *  filename,
const int  force,
AStorageManager_obbCallbackFunc  cb,
void *  data 
)

Attempts to unmount an OBB file. This is an asynchronous operation.