Top level functions

Functions that affect Eet as a whole. More...

Typedefs

typedef enum _Eet_Error Eet_Error
 Eet error identifiers.

Enumerations

enum  _Eet_Error {
  EET_ERROR_NONE,
  EET_ERROR_BAD_OBJECT,
  EET_ERROR_EMPTY,
  EET_ERROR_NOT_WRITABLE,
  EET_ERROR_OUT_OF_MEMORY,
  EET_ERROR_WRITE_ERROR,
  EET_ERROR_WRITE_ERROR_FILE_TOO_BIG,
  EET_ERROR_WRITE_ERROR_IO_ERROR,
  EET_ERROR_WRITE_ERROR_OUT_OF_SPACE,
  EET_ERROR_WRITE_ERROR_FILE_CLOSED,
  EET_ERROR_MMAP_FAILED,
  EET_ERROR_X509_ENCODING_FAILED,
  EET_ERROR_SIGNATURE_FAILED,
  EET_ERROR_INVALID_SIGNATURE,
  EET_ERROR_NOT_SIGNED,
  EET_ERROR_NOT_IMPLEMENTED,
  EET_ERROR_PRNG_NOT_SEEDED,
  EET_ERROR_ENCRYPT_FAILED,
  EET_ERROR_DECRYPT_FAILED
}
 All the error identifiers known by Eet. More...

Functions

int eet_init (void)
 Initialize the EET library.
int eet_shutdown (void)
 Shut down the EET library.
void eet_clearcache (void)
 Clear eet cache.

Detailed Description

Functions that affect Eet as a whole.


Enumeration Type Documentation

enum _Eet_Error

All the error identifiers known by Eet.

Enumerator:
EET_ERROR_NONE  No error, it's all fine!
EET_ERROR_BAD_OBJECT  Given object or handle is NULL or invalid.
EET_ERROR_EMPTY  There was nothing to do.
EET_ERROR_NOT_WRITABLE  Could not write to file or file is EET_FILE_MODE_READ.
EET_ERROR_OUT_OF_MEMORY  Could not allocate memory.
EET_ERROR_WRITE_ERROR  Failed to write data to destination.
EET_ERROR_WRITE_ERROR_FILE_TOO_BIG  Failed to write file since it is too big.
EET_ERROR_WRITE_ERROR_IO_ERROR  Failed to write due a generic Input/Output error.
EET_ERROR_WRITE_ERROR_OUT_OF_SPACE  Failed to write due out of space.
EET_ERROR_WRITE_ERROR_FILE_CLOSED  Failed to write because file was closed.
EET_ERROR_MMAP_FAILED  Could not mmap file.
EET_ERROR_X509_ENCODING_FAILED  Could not encode using X509.
EET_ERROR_SIGNATURE_FAILED  Could not validate signature.
EET_ERROR_INVALID_SIGNATURE  Signature is invalid.
EET_ERROR_NOT_SIGNED  File or contents are not signed.
EET_ERROR_NOT_IMPLEMENTED  Function is not implemented.
EET_ERROR_PRNG_NOT_SEEDED  Could not introduce random seed.
EET_ERROR_ENCRYPT_FAILED  Could not encrypt contents.
EET_ERROR_DECRYPT_FAILED  Could not decrypt contents.


Function Documentation

int eet_init ( void   ) 

Initialize the EET library.

The first time this function is called, it will perform all the internal initialization required for the library to function properly and incrememnt the initializiation counter. Any subsequent call only increment this counter and return its new value, so it's safe to call this function more than once.

Returns:
The new init count. Will be 0 if initialization failed.
Since:
1.0.0

int eet_shutdown ( void   ) 

Shut down the EET library.

If eet_init() was called more than once for the running application, eet_shutdown() will decrement the initialization counter and return its new value, without doing anything else. When the counter reaches 0, all of the internal elements will be shutdown and any memory used freed.

Returns:
The new init count.
Since:
1.0.0

References eet_clearcache().

void eet_clearcache ( void   ) 

Clear eet cache.

For a faster access to previously accessed data, Eet keeps an internal cache of files. These files will be freed automatically only when they are unused and the cache gets full, in order based on the last time they were used. On systems with little memory this may present an unnecessary constraint, so eet_clearcache() is available for users to reclaim the memory used by files that are no longer needed. Those that were open using EET_FILE_MODE_WRITE or EET_FILE_MODE_READ_WRITE and have modifications, will be written down to disk before flushing them from memory.

Since:
1.0.0

Referenced by eet_shutdown().