Eet.h   Eet.h 
skipping to change at line 47 skipping to change at line 47
/** /**
* @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 2 #define EET_VERSION_MINOR 3
/** /**
* @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
* runtiime to detect which version of eet is being used and adapt * runtiime 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( EET_VERSION_MINOR) && (EET_VERSION_MINOR > 2) * #if defined(EET_VERSION_MAJOR) && (EET_VERSION_MAJOR >= 1) && defined( EET_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 2809 skipping to change at line 2809
* @oaram eet_read_cb Function to call when one Eet_Data packet has been fully assemble. * @oaram eet_read_cb Function to call when one Eet_Data packet has been fully assemble.
* @param eet_write_cb Function to call when one Eet_Data packet is ready to be send over the wire. * @param eet_write_cb Function to call when one Eet_Data packet is ready to be send over the wire.
* @param user_data Pointer provided to both functions to be used as a co ntext handler. * @param user_data Pointer provided to both functions to be used as a co ntext handler.
* @return NULL on failure, or a valid Eet_Connection handler. * @return NULL on failure, or a valid Eet_Connection handler.
* *
* For every connection to track you will need a separate Eet_Connection provider. * For every connection to track you will need a separate Eet_Connection provider.
* *
* @since 1.2.4 * @since 1.2.4
* @ingroup Eet_Connection_Group * @ingroup Eet_Connection_Group
*/ */
Eet_Connection *eet_connection_new(Eet_Read_Cb *eet_read_cb, Eet_Write_C b *eet_write_cb, const void *user_data); EAPI Eet_Connection *eet_connection_new(Eet_Read_Cb *eet_read_cb, Eet_Wr ite_Cb *eet_write_cb, const void *user_data);
/** /**
* Process a raw packet received over the link * Process a raw packet received over the link
* @oaram conn Connection handler to track. * @oaram conn Connection handler to track.
* @param data Raw data packet. * @param data Raw data packet.
* @param size The size of that packet. * @param size The size of that packet.
* @return 0 on complete success, any other value indicate where in the s tream it got wrong (It could be before that packet). * @return 0 on complete success, any other value indicate where in the s tream it got wrong (It could be before that packet).
* *
* Every time you receive a packet related to your connection, you should pass * Every time you receive a packet related to your connection, you should pass
* it to that function so that it could process and assemble packet has y ou * it to that function so that it could process and assemble packet has y ou
* receive it. It will automatically call Eet_Read_Cb when one is fully r eceived. * receive it. It will automatically call Eet_Read_Cb when one is fully r eceived.
* *
* @since 1.2.4 * @since 1.2.4
* @ingroup Eet_Connection_Group * @ingroup Eet_Connection_Group
*/ */
int eet_connection_received(Eet_Connection *conn, const void *data, size _t size); EAPI int eet_connection_received(Eet_Connection *conn, const void *data, size_t size);
/** /**
* Convert a complex structure and prepare it to be send. * Convert a complex structure and prepare it to be send.
* @oaram conn Connection handler to track. * @oaram 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 don't. * @return EINA_TRUE if the data where correctly send, EINA_FALSE if they don'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 al located * Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary al located
* and will vanish just after the return of the callback. * and will vanish just after the return of the callback.
* *
* @see eet_data_descriptor_encode_cipher * @see eet_data_descriptor_encode_cipher
* *
* @since 1.2.4 * @since 1.2.4
* @ingroup Eet_Connection_Group * @ingroup Eet_Connection_Group
*/ */
Eina_Bool eet_connection_send(Eet_Connection *conn, Eet_Data_Descriptor *edd, const void *data_in, const char *cipher_key); EAPI Eina_Bool eet_connection_send(Eet_Connection *conn, Eet_Data_Descri ptor *edd, const void *data_in, const char *cipher_key);
/** /**
* Convert a Eet_Node tree and prepare it to be send. * Convert a Eet_Node tree and prepare it to be send.
* @oaram conn Connection handler to track. * @oaram conn Connection handler to track.
* @param node The data tree to use when encoding. * @param node The data tree to use when encoding.
* @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 don't. * @return EINA_TRUE if the data where correctly send, EINA_FALSE if they don't.
* *
* This function serialize node, assemble the packet and call * This function serialize node, assemble the packet and call
* Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary al located * Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary al located
* and will vanish just after the return of the callback. * and will vanish just after the return of the callback.
* *
* @see eet_data_node_encode_cipher * @see eet_data_node_encode_cipher
* *
* @since 1.2.4 * @since 1.2.4
* @ingroup Eet_Connection_Group * @ingroup Eet_Connection_Group
*/ */
Eina_Bool eet_connection_node_send(Eet_Connection *conn, Eet_Node *node, const char *cipher_key); EAPI Eina_Bool eet_connection_node_send(Eet_Connection *conn, Eet_Node * node, const char *cipher_key);
/** /**
* Close a connection and lost its track. * Close a connection and lost its track.
* @oaram conn Connection handler to close. * @oaram conn Connection handler to close.
* @param on_going Signal if a partial packet wasn't completed. * @param on_going Signal if a partial packet wasn't completed.
* @return the user_data passed to both callback. * @return the user_data passed to both callback.
* *
* @since 1.2.4 * @since 1.2.4
* @ingroup Eet_Connection_Group * @ingroup Eet_Connection_Group
*/ */
void *eet_connection_close(Eet_Connection *conn, Eina_Bool *on_going); EAPI void *eet_connection_close(Eet_Connection *conn, Eina_Bool *on_goin g);
/************************************************************************** */ /************************************************************************** */
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
#endif #endif
 End of changes. 6 change blocks. 
6 lines changed or deleted 6 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/