Mercurial > pidgin
changeset 29795:c138390bada8
It broke a bit during merge.
And the _reserved in the ui ops struct ran out...
author | Marcus Lundblad <ml@update.uu.se> |
---|---|
date | Thu, 13 Aug 2009 17:40:00 +0000 |
parents | 52cb819c6668 |
children | 7763697a85c8 |
files | libpurple/ft.h |
diffstat | 1 files changed, 102 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/libpurple/ft.h Thu Aug 13 17:15:06 2009 +0000 +++ b/libpurple/ft.h Thu Aug 13 17:40:00 2009 +0000 @@ -76,9 +76,51 @@ void (*update_progress)(PurpleXfer *xfer, double percent); void (*cancel_local)(PurpleXfer *xfer); void (*cancel_remote)(PurpleXfer *xfer); - void (*add_thumbnail)(PurpleXfer *xfer); + + /** + * UI op to write data received from the prpl. The UI must deal with the + * entire buffer and return size, or it is treated as an error. + * + * @param xfer The file transfer structure + * @param buffer The buffer to write + * @param size The size of the buffer + * + * @return size if the write was successful, or a value between 0 and + * size on error. + * @since 2.6.0 + */ + gssize (*ui_write)(PurpleXfer *xfer, const guchar *buffer, gssize size); - void (*_purple_reserved1)(void); + /** + * UI op to read data to send to the prpl for a file transfer. + * + * @param xfer The file transfer structure + * @param buffer A pointer to a buffer. The UI must allocate this buffer. + * libpurple will free the data. + * @param size The maximum amount of data to put in the buffer. + * + * @returns The amount of data in the buffer, 0 if nothing is available, + * and a negative value if an error occurred and the transfer + * should be cancelled (libpurple will cancel). + * @since 2.6.0 + */ + gssize (*ui_read)(PurpleXfer *xfer, guchar **buffer, gssize size); + + /** + * Op to notify the UI that not all the data read in was written. The UI + * should re-enqueue this data and return it the next time read is called. + * + * This MUST be implemented if read and write are implemented. + * + * @param xfer The file transfer structure + * @param buffer A pointer to the beginning of the unwritten data. + * @param size The amount of unwritten data. + * + * @since 2.6.0 + */ + void (*data_not_sent)(PurpleXfer *xfer, const guchar *buffer, gsize size); + + void (*add_thumbnail)(PurpleXfer *xfer); } PurpleXferUiOps; /** @@ -623,6 +665,64 @@ */ void purple_xfer_conversation_write(PurpleXfer *xfer, char *message, gboolean is_error); +/** + * Allows the UI to signal it's ready to send/receive data (depending on + * the direction of the file transfer. Used when the UI is providing + * read/write/data_not_sent UI ops. + * + * @param xfer The file transfer which is ready. + * + * @since 2.6.0 + */ +void purple_xfer_ui_ready(PurpleXfer *xfer); + +/** + * Allows the prpl to signal it's readh to send/receive data (depending on + * the direction of the file transfer. Used when the prpl provides read/write + * ops and cannot/does not provide a raw fd to the core. + * + * @param xfer The file transfer which is ready. + * + * @since 2.6.0 + */ +void purple_xfer_prpl_ready(PurpleXfer *xfer); + +/** + * Gets the thumbnail data for a transfer + * + * @param xfer The file transfer to get the thumbnail for + * @return The thumbnail data, or NULL if there is no thumbnail + */ +const void *purple_xfer_get_thumbnail_data(const PurpleXfer *xfer); + +/** + * Gets the thumbnail size for a transfer + * + * @param xfer The file transfer to get the thumbnail size for + * @return The size, in bytes of the file transfer's thumbnail + */ +gsize purple_xfer_get_thumbnail_size(const PurpleXfer *xfer); + + +/** + * Sets the thumbnail data for a transfer + * + * @param xfer The file transfer to set the data for + * @param thumbnail A pointer to the thumbnail data, this will be copied + * @param size The size in bytes of the passed in thumbnail data + */ +void purple_xfer_set_thumbnail(PurpleXfer *xfer, gconstpointer thumbnail, + gsize size); + +/** + * Prepare a thumbnail for a transfer (if the UI supports it) + * will be no-op in case the UI doesn't implement thumbnail creation + * + * @param xfer The file transfer to create a thumbnail for + */ +void purple_xfer_prepare_thumbnail(PurpleXfer *xfer); + + /*@}*/ /**************************************************************************/