Top level functions(3) Functions that affect Eet as a whole.

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.

Functions


EAPI int eet_init (void)
Initialize the EET library.
EAPI int eet_shutdown (void)
Shut down the EET library.
EAPI 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 fine 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 since 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

EAPI void eet_clearcache (void)

Clear eet cache. Eet didn't free items by default. If you are under memory presure, just call this function to recall all memory that are not yet referenced anymore. The cache take care of modification on disk.

Since:

1.0.0

Referenced by eet_shutdown().

EAPI int eet_init (void)

Initialize the EET library. Returns:

The new init count.

Since:

1.0.0

EAPI int eet_shutdown (void)

Shut down the EET library. Returns:

The new init count.

Since:

1.0.0

References eet_clearcache().

Author

Generated automatically by Doxygen for Eet from the source code.