Eet.h | Eet.h | |||
---|---|---|---|---|
/** | /** | |||
@brief Eet Data Handling Library Public API Calls | @brief Eet Data Handling Library Public API Calls | |||
These routines are used for Eet Library interaction | These routines are used for Eet Library interaction | |||
@mainpage Eet Library Documentation | @mainpage Eet Library Documentation | |||
@version 1.5.0 | @version 1.7.0 | |||
@date 2000-2012 | @date 2000-2012 | |||
Please see the @ref authors page for contact details. | Please see the @ref authors page for contact details. | |||
@section toc Table of Contents | @section toc Table of Contents | |||
@li @ref intro | @li @ref intro | |||
@li @ref example | @li @ref example | |||
@li @ref compiling | @li @ref compiling | |||
@li @ref install | @li @ref install | |||
skipping to change at line 190 | skipping to change at line 190 | |||
/** | /** | |||
* @file Eet.h | * @file Eet.h | |||
* @brief The file that provides the eet functions. | * @brief The file that provides the eet functions. | |||
* | * | |||
* This header provides the Eet management functions. | * This header provides the Eet management functions. | |||
* | * | |||
*/ | */ | |||
#define EET_VERSION_MAJOR 1 | #define EET_VERSION_MAJOR 1 | |||
#define EET_VERSION_MINOR 6 | #define EET_VERSION_MINOR 7 | |||
/** | /** | |||
* @typedef Eet_Version | * @typedef Eet_Version | |||
* | * | |||
* This is the Eet version information structure that can be used at | * This is the Eet version information structure that can be used at | |||
* runtime to detect which version of eet is being used and adapt | * runtime to detect which version of eet is being used and adapt | |||
* appropriately as follows for example: | * appropriately as follows for example: | |||
* | * | |||
* @code | * @code | |||
* #if defined(EET_VERSION_MAJOR) && (EET_VERSION_MAJOR >= 1) && defined(EE T_VERSION_MINOR) && (EET_VERSION_MINOR > 2) | * #if defined(EET_VERSION_MAJOR) && (EET_VERSION_MAJOR >= 1) && defined(EE T_VERSION_MINOR) && (EET_VERSION_MINOR > 2) | |||
* printf("Eet version: %i.%i.%i\n", | * printf("Eet version: %i.%i.%i\n", | |||
skipping to change at line 263 | skipping to change at line 263 | |||
EET_ERROR_PRNG_NOT_SEEDED, /**< Could not introduce random seed */ | EET_ERROR_PRNG_NOT_SEEDED, /**< Could not introduce random seed */ | |||
EET_ERROR_ENCRYPT_FAILED, /**< Could not encrypt contents */ | EET_ERROR_ENCRYPT_FAILED, /**< Could not encrypt contents */ | |||
EET_ERROR_DECRYPT_FAILED /**< Could not decrypt contents */ | EET_ERROR_DECRYPT_FAILED /**< Could not decrypt contents */ | |||
} Eet_Error; /**< Eet error identifiers */ | } Eet_Error; /**< Eet error identifiers */ | |||
/** | /** | |||
* @} | * @} | |||
*/ | */ | |||
/** | /** | |||
* @defgroup Eet_Compression Eet Compression Levels | ||||
* Compression modes/levels supported by Eet. | ||||
* | ||||
* @{ | ||||
*/ | ||||
/** | ||||
* @enum _Eet_Compression | ||||
* All the compression modes known by Eet. | ||||
*/ | ||||
typedef enum _Eet_Compression | ||||
{ | ||||
EET_COMPRESSION_NONE = 0, /**< No compression at all @since 1.7 */ | ||||
EET_COMPRESSION_DEFAULT = 1, /**< Default compression (Zlib) @since 1 | ||||
.7 */ | ||||
EET_COMPRESSION_LOW = 2, /**< Fast but minimal compression (Zlib) | ||||
@since 1.7 */ | ||||
EET_COMPRESSION_MED = 6, /**< Medium compression level (Zlib) @si | ||||
nce 1.7 */ | ||||
EET_COMPRESSION_HI = 9, /**< Slow but high compression level (Zl | ||||
ib) @since 1.7 */ | ||||
EET_COMPRESSION_VERYFAST = 10, /**< Very fast, but lower compression ra | ||||
tio (LZ4HC) @since 1.7 */ | ||||
EET_COMPRESSION_SUPERFAST = 11, /**< Very fast, but lower compression ra | ||||
tio (faster to compress than EET_COMPRESSION_VERYFAST) (LZ4) @since 1.7 */ | ||||
EET_COMPRESSION_LOW2 = 3, /**< Space filler for compatibility. Don | ||||
't use it @since 1.7 */ | ||||
EET_COMPRESSION_MED1 = 4, /**< Space filler for compatibility. Don | ||||
't use it @since 1.7 */ | ||||
EET_COMPRESSION_MED2 = 5, /**< Space filler for compatibility. Don | ||||
't use it @since 1.7 */ | ||||
EET_COMPRESSION_HI1 = 7, /**< Space filler for compatibility. Don | ||||
't use it @since 1.7 */ | ||||
EET_COMPRESSION_HI2 = 8 /**< Space filler for compatibility. Don | ||||
't use it @since 1.7 */ | ||||
} Eet_Compression; /**< Eet compression modes @since 1.7 */ | ||||
/** | ||||
* @} | ||||
*/ | ||||
/** | ||||
* Initialize the EET library. | * Initialize the EET library. | |||
* | * | |||
* The first time this function is called, it will perform all the internal | * The first time this function is called, it will perform all the internal | |||
* initialization required for the library to function properly and increme nt | * initialization required for the library to function properly and increme nt | |||
* the initialization counter. Any subsequent call only increment this coun ter | * the initialization counter. Any subsequent call only increment this coun ter | |||
* and return its new value, so it's safe to call this function more than o nce. | * and return its new value, so it's safe to call this function more than o nce. | |||
* | * | |||
* @return The new init count. Will be 0 if initialization failed. | * @return The new init count. Will be 0 if initialization failed. | |||
* | * | |||
* @since 1.0.0 | * @since 1.0.0 | |||
skipping to change at line 4161 | skipping to change at line 4194 | |||
* | * | |||
* @since 1.2.4 | * @since 1.2.4 | |||
* @ingroup Eet_Connection_Group | * @ingroup Eet_Connection_Group | |||
*/ | */ | |||
EAPI int | EAPI int | |||
eet_connection_received(Eet_Connection *conn, | eet_connection_received(Eet_Connection *conn, | |||
const void *data, | const void *data, | |||
size_t size); | size_t size); | |||
/** | /** | |||
* Tell if the Eet_Connection as received some partial data. | ||||
* @param conn Connection handler to request. | ||||
* @return EINA_TRUE if there is some data pending inside, EINA_FALSE other | ||||
wise. | ||||
* | ||||
* Eet_Connection buffer data until the received data can be unserialized c | ||||
orrectly. This | ||||
* function let you know if there is some data inside that buffer waiting f | ||||
or more data to | ||||
* be received before being processed. | ||||
* | ||||
* @since 1.7 | ||||
* @ingroup Eet_Connection_Group | ||||
*/ | ||||
EAPI Eina_Bool eet_connection_empty(Eet_Connection *conn); | ||||
/** | ||||
* Convert a complex structure and prepare it to be send. | * Convert a complex structure and prepare it to be send. | |||
* @param conn Connection handler to track. | * @param conn Connection handler to track. | |||
* @param edd The data descriptor to use when encoding. | * @param edd The data descriptor to use when encoding. | |||
* @param data_in The pointer to the struct to encode into data. | * @param data_in The pointer to the struct to encode into data. | |||
* @param cipher_key The key to use as cipher. | * @param cipher_key The key to use as cipher. | |||
* @return EINA_TRUE if the data where correctly send, EINA_FALSE if they d on't. | * @return EINA_TRUE if the data where correctly send, EINA_FALSE if they d on't. | |||
* | * | |||
* This function serialize data_in with edd, assemble the packet and call | * This function serialize data_in with edd, assemble the packet and call | |||
* Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary allo cated | * Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary allo cated | |||
* and will vanish just after the return of the callback. | * and will vanish just after the return of the callback. | |||
End of changes. 4 change blocks. | ||||
2 lines changed or deleted | 63 lines changed or added | |||