Kanzi Android framework API
KanziRuntime Class Reference

Kanzi runtime infrastructure for an Android application. More...

Collaboration diagram for KanziRuntime:
[legend]

Public Member Functions

void executeNativeGarbageCollection ()
 Executes the native garbage collection manually. More...
 
Domain getDomain ()
 Returns the Kanzi UI domain that was created for this runtime. More...
 
void loadKzb (String binaryFilename) throws FileNotFoundException
 Loads a given Kanzi binary file. More...
 
void scheduleNativeGarbageCollection (long delayInMs)
 Schedules automatic garbage collection of native objects to occur on given interval. More...
 
void stopNativeGarbageCollection ()
 Cancels automatic garbage collection of native objects started by scheduleNativeGarbageCollection(long delayInMs).
 

Static Public Member Functions

static KanziRuntime getInstance (Context context)
 Retrieve the Kanzi runtime singleton for this application. More...
 

Detailed Description

Kanzi runtime infrastructure for an Android application.

Member Function Documentation

void executeNativeGarbageCollection ( )

Executes the native garbage collection manually.

This operation can be set to be performed periodically by calling scheduleNativeGarbageCollection(long delayInMs).

Domain getDomain ( )

Returns the Kanzi UI domain that was created for this runtime.

Returns
Domain for this runtime.
static KanziRuntime getInstance ( Context  context)
static

Retrieve the Kanzi runtime singleton for this application.

Parameters
contextAndroid application context.
Returns
Kanzi runtime instance for this application.
void loadKzb ( String  binaryFilename) throws FileNotFoundException

Loads a given Kanzi binary file.

Parameters
binaryFilenameFile path to kzb file.
Exceptions
FileNotFoundExceptionThrows a FileNotFoundException when the Kanzi binary file can not be found.
InvalidKzbFileExceptionThrows a InvalidKzbFileException when the Kanzi binary file is invalid.
void scheduleNativeGarbageCollection ( long  delayInMs)

Schedules automatic garbage collection of native objects to occur on given interval.

In case the automatic garbage collection is not desired, it must be called manually.

Parameters
delayInMsInterval for garbage collection, in milliseconds.