Main Page | Modules | Namespace List | Class Hierarchy | Data Structures | Directories | File List | Namespace Members | Data Fields | Globals

_AlpBundleProgressiveData Struct Reference

#include <include/hiker/bundlemgr.h>


Public Types

enum  {
  ALP_BUNDLE_PROGRESSIVE_HAVE_BYTES_SO_FAR = 1<<0, ALP_BUNDLE_PROGRESSIVE_HAVE_TOTAL_BYTES = 1<<1, ALP_BUNDLE_PROGRESSIVE_HAVE_MAX_OVERHEAD = 1<<2, ALP_BUNDLE_PROGRESSIVE_HAVE_METADATA = 1<<3,
  ALP_BUNDLE_PROGRESSIVE_HAVE_PROPERTIES = 1<<4, ALP_BUNDLE_PROGRESSIVE_HAVE_FILENAME = 1<<5, ALP_BUNDLE_PROGRESSIVE_HAVE_MIMETYPE = 1<<6, ALP_BUNDLE_PROGRESSIVE_HAVE_STORE = 1<<7,
  ALP_BUNDLE_PROGRESSIVE_HAVE_OVERWRITING_PKGINDEX = 1<<8, ALP_BUNDLE_PROGRESSIVE_HAVE_PKGINDEX = 1<<9, ALP_BUNDLE_PROGRESSIVE_HAVE_FINISHED = 1<<10
}

Data Fields

gint version
 Caller should set this to ALP_BUNDLE_PROGRESSIVE_DATA_VERSION, so that the image routines know what layout the caller is using.
gboolean(* callback )(AlpBundleProgressiveData *)
 Caller should set this.
enum _AlpBundleProgressiveData:: { ... }  ALP_BUNDLE_PROGRESSIVE_ENUM
guint new_state
 Any ALP_BUNDLE_PROGRESSIVE_HAVE_.
guint current_state
 Any ALP_BUNDLE_PROGRESSIVE_HAVE_.
guint bytes_so_far
 Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_BYTES_SO_FAR, 0 otherwise This field indicates how many bytes of data have been processed.
guint total_bytes
 Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_TOTAL_BYTES, 0 otherwise This field indicates how many bytes in total are needed.
guint max_overhead
 Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_OVERHEAD, 0 otherwise This field indicates how much space has been temporarily used on the system in order to process the stream.
GHashTable * metadata
 Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_METADATA, NULL otherwise.
GHashTable * properties
 Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_PROPERTIES, NULL otherwise.
const char * recommended_filename
 Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_FILENAME, NULL otherwise.
const char * recommended_mimetype
 Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_MIMETYPE, NULL otherwise.
const char * store
 Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_STORE, NULL otherwise.
AlpBundle overwriting_index
 Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_OVERWRITING_PKGINDEX, NULL otherwise.
AlpBundle index
 Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_PKGINDEX, NULL otherwise.
void * userdata
 This field is intended for the caller to refer to any additional data that might be needed, for state, etc.


Member Enumeration Documentation

anonymous enum
 

Enumerator:
ALP_BUNDLE_PROGRESSIVE_HAVE_BYTES_SO_FAR 
ALP_BUNDLE_PROGRESSIVE_HAVE_TOTAL_BYTES 
ALP_BUNDLE_PROGRESSIVE_HAVE_MAX_OVERHEAD 
ALP_BUNDLE_PROGRESSIVE_HAVE_METADATA 
ALP_BUNDLE_PROGRESSIVE_HAVE_PROPERTIES 
ALP_BUNDLE_PROGRESSIVE_HAVE_FILENAME 
ALP_BUNDLE_PROGRESSIVE_HAVE_MIMETYPE 
ALP_BUNDLE_PROGRESSIVE_HAVE_STORE 
ALP_BUNDLE_PROGRESSIVE_HAVE_OVERWRITING_PKGINDEX 
ALP_BUNDLE_PROGRESSIVE_HAVE_PKGINDEX 
ALP_BUNDLE_PROGRESSIVE_HAVE_FINISHED 


Field Documentation

enum { ... } _AlpBundleProgressiveData::ALP_BUNDLE_PROGRESSIVE_ENUM
 

guint _AlpBundleProgressiveData::bytes_so_far
 

Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_BYTES_SO_FAR, 0 otherwise This field indicates how many bytes of data have been processed.

gboolean(* _AlpBundleProgressiveData::callback)(AlpBundleProgressiveData *)
 

Caller should set this.

The callback should return TRUE if it wants to abort the image routine.

guint _AlpBundleProgressiveData::current_state
 

Any ALP_BUNDLE_PROGRESSIVE_HAVE_.

.. flags which are set in this member indicate that the respective fields are valid.

AlpBundle _AlpBundleProgressiveData::index
 

Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_PKGINDEX, NULL otherwise.

guint _AlpBundleProgressiveData::max_overhead
 

Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_OVERHEAD, 0 otherwise This field indicates how much space has been temporarily used on the system in order to process the stream.

Any overhead space will be released before the image call returns.

GHashTable* _AlpBundleProgressiveData::metadata
 

Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_METADATA, NULL otherwise.

guint _AlpBundleProgressiveData::new_state
 

Any ALP_BUNDLE_PROGRESSIVE_HAVE_.

.. flags which are added to current_state in this invocation of the callback will also be listed in new_state, for the convenience of the callback.

AlpBundle _AlpBundleProgressiveData::overwriting_index
 

Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_OVERWRITING_PKGINDEX, NULL otherwise.

GHashTable* _AlpBundleProgressiveData::properties
 

Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_PROPERTIES, NULL otherwise.

const char* _AlpBundleProgressiveData::recommended_filename
 

Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_FILENAME, NULL otherwise.

const char* _AlpBundleProgressiveData::recommended_mimetype
 

Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_MIMETYPE, NULL otherwise.

const char* _AlpBundleProgressiveData::store
 

Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_STORE, NULL otherwise.

guint _AlpBundleProgressiveData::total_bytes
 

Valid only if ALP_BUNDLE_PROGRESSIVE_HAVE_TOTAL_BYTES, 0 otherwise This field indicates how many bytes in total are needed.

void* _AlpBundleProgressiveData::userdata
 

This field is intended for the caller to refer to any additional data that might be needed, for state, etc.

gint _AlpBundleProgressiveData::version
 

Caller should set this to ALP_BUNDLE_PROGRESSIVE_DATA_VERSION, so that the image routines know what layout the caller is using.


The documentation for this struct was generated from the following file:
Generated on Sat Dec 16 20:29:49 2006 for hiker-0.9 by  doxygen 1.4.4