File Transfer API. More...

#include <glib.h>
#include <stdio.h>
#include "account.h"

Include dependency graph for ft.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	PurpleXferUiOps
	File transfer UI operations. More...

struct	_PurpleXfer
	A core representation of a file transfer. More...

Typedefs
typedef struct _PurpleXfer	PurpleXfer
	Data Structures More...

Enumerations
enum	PurpleXferType { PURPLE_XFER_UNKNOWN = 0 , PURPLE_XFER_SEND , PURPLE_XFER_RECEIVE }
	Types of file transfers. More...

enum	PurpleXferStatusType { PURPLE_XFER_STATUS_UNKNOWN = 0 , PURPLE_XFER_STATUS_NOT_STARTED , PURPLE_XFER_STATUS_ACCEPTED , PURPLE_XFER_STATUS_STARTED , PURPLE_XFER_STATUS_DONE , PURPLE_XFER_STATUS_CANCEL_LOCAL , PURPLE_XFER_STATUS_CANCEL_REMOTE }
	The different states of the xfer. More...

Functions
File Transfer API <br>
PurpleXfer *	purple_xfer_new (PurpleAccount account, PurpleXferType type, const char who)
	Creates a new file transfer handle. More...

GList *	purple_xfers_get_all (void)
	Returns all xfers. More...

void	purple_xfer_ref (PurpleXfer *xfer)
	Increases the reference count on a PurpleXfer. More...

void	purple_xfer_unref (PurpleXfer *xfer)
	Decreases the reference count on a PurpleXfer. More...

void	purple_xfer_request (PurpleXfer *xfer)
	Requests confirmation for a file transfer from the user. More...

void	purple_xfer_request_accepted (PurpleXfer xfer, const char filename)
	Called if the user accepts the file transfer request. More...

void	purple_xfer_request_denied (PurpleXfer *xfer)
	Called if the user rejects the file transfer request. More...

PurpleXferType	purple_xfer_get_type (const PurpleXfer *xfer)
	Returns the type of file transfer. More...

PurpleAccount *	purple_xfer_get_account (const PurpleXfer *xfer)
	Returns the account the file transfer is using. More...

const char *	purple_xfer_get_remote_user (const PurpleXfer *xfer)
	Returns the name of the remote user. More...

PurpleXferStatusType	purple_xfer_get_status (const PurpleXfer *xfer)
	Returns the status of the xfer. More...

gboolean	purple_xfer_is_canceled (const PurpleXfer *xfer)
	Returns true if the file transfer was cancelled. More...

gboolean	purple_xfer_is_completed (const PurpleXfer *xfer)
	Returns the completed state for a file transfer. More...

const char *	purple_xfer_get_filename (const PurpleXfer *xfer)
	Returns the name of the file being sent or received. More...

const char *	purple_xfer_get_local_filename (const PurpleXfer *xfer)
	Returns the file's destination filename,. More...

size_t	purple_xfer_get_bytes_sent (const PurpleXfer *xfer)
	Returns the number of bytes sent (or received) so far. More...

size_t	purple_xfer_get_bytes_remaining (const PurpleXfer *xfer)
	Returns the number of bytes remaining to send or receive. More...

size_t	purple_xfer_get_size (const PurpleXfer *xfer)
	Returns the size of the file being sent or received. More...

double	purple_xfer_get_progress (const PurpleXfer *xfer)
	Returns the current percentage of progress of the transfer. More...

unsigned int	purple_xfer_get_local_port (const PurpleXfer *xfer)
	Returns the local port number in the file transfer. More...

const char *	purple_xfer_get_remote_ip (const PurpleXfer *xfer)
	Returns the remote IP address in the file transfer. More...

unsigned int	purple_xfer_get_remote_port (const PurpleXfer *xfer)
	Returns the remote port number in the file transfer. More...

time_t	purple_xfer_get_start_time (const PurpleXfer *xfer)
	Returns the time the transfer of a file started. More...

time_t	purple_xfer_get_end_time (const PurpleXfer *xfer)
	Returns the time the transfer of a file ended. More...

void	purple_xfer_set_completed (PurpleXfer *xfer, gboolean completed)
	Sets the completed state for the file transfer. More...

void	purple_xfer_set_message (PurpleXfer xfer, const char message)
	Sets the filename for the file transfer. More...

void	purple_xfer_set_filename (PurpleXfer xfer, const char filename)
	Sets the filename for the file transfer. More...

void	purple_xfer_set_local_filename (PurpleXfer xfer, const char filename)
	Sets the local filename for the file transfer. More...

void	purple_xfer_set_size (PurpleXfer *xfer, size_t size)
	Sets the size of the file in a file transfer. More...

void	purple_xfer_set_bytes_sent (PurpleXfer *xfer, size_t bytes_sent)
	Sets the current working position in the active file transfer. More...

PurpleXferUiOps *	purple_xfer_get_ui_ops (const PurpleXfer *xfer)
	Returns the UI operations structure for a file transfer. More...

void	purple_xfer_set_read_fnc (PurpleXfer xfer, gssize(fnc)(guchar *, PurpleXfer ))
	Sets the read function for the file transfer. More...

void	purple_xfer_set_write_fnc (PurpleXfer xfer, gssize(fnc)(const guchar , size_t, PurpleXfer ))
	Sets the write function for the file transfer. More...

void	purple_xfer_set_ack_fnc (PurpleXfer xfer, void(fnc)(PurpleXfer , const guchar , size_t))
	Sets the acknowledge function for the file transfer. More...

void	purple_xfer_set_request_denied_fnc (PurpleXfer xfer, void(fnc)(PurpleXfer *))
	Sets the function to be called if the request is denied. More...

void	purple_xfer_set_init_fnc (PurpleXfer xfer, void(fnc)(PurpleXfer *))
	Sets the transfer initialization function for the file transfer. More...

void	purple_xfer_set_start_fnc (PurpleXfer xfer, void(fnc)(PurpleXfer *))
	Sets the start transfer function for the file transfer. More...

void	purple_xfer_set_end_fnc (PurpleXfer xfer, void(fnc)(PurpleXfer *))
	Sets the end transfer function for the file transfer. More...

void	purple_xfer_set_cancel_send_fnc (PurpleXfer xfer, void(fnc)(PurpleXfer *))
	Sets the cancel send function for the file transfer. More...

void	purple_xfer_set_cancel_recv_fnc (PurpleXfer xfer, void(fnc)(PurpleXfer *))
	Sets the cancel receive function for the file transfer. More...

gssize	purple_xfer_read (PurpleXfer xfer, guchar *buffer)
	Reads in data from a file transfer stream. More...

gssize	purple_xfer_write (PurpleXfer xfer, const guchar buffer, gsize size)
	Writes data to a file transfer stream. More...

gboolean	purple_xfer_write_file (PurpleXfer xfer, const guchar buffer, gsize size)
	Writes chunk of received file. More...

gssize	purple_xfer_read_file (PurpleXfer xfer, guchar buffer, gsize size)
	Writes chunk of file being sent. More...

void	purple_xfer_start (PurpleXfer xfer, int fd, const char ip, unsigned int port)
	Starts a file transfer. More...

void	purple_xfer_end (PurpleXfer *xfer)
	Ends a file transfer. More...

void	purple_xfer_add (PurpleXfer *xfer)
	Adds a new file transfer to the list of file transfers. More...

void	purple_xfer_cancel_local (PurpleXfer *xfer)
	Cancels a file transfer on the local end. More...

void	purple_xfer_cancel_remote (PurpleXfer *xfer)
	Cancels a file transfer from the remote end. More...

void	purple_xfer_error (PurpleXferType type, PurpleAccount account, const char who, const char *msg)
	Displays a file transfer-related error message. More...

void	purple_xfer_update_progress (PurpleXfer *xfer)
	Updates file transfer progress. More...

void	purple_xfer_conversation_write (PurpleXfer xfer, char message, gboolean is_error)
	Displays a file transfer-related message in the conversation window. More...

void	purple_xfer_ui_ready (PurpleXfer *xfer)
	Allows the UI to signal it's ready to send/receive data (depending on the direction of the file transfer. More...

void	purple_xfer_prpl_ready (PurpleXfer *xfer)
	Allows the prpl to signal it's ready to send/receive data (depending on the direction of the file transfer. More...

gconstpointer	purple_xfer_get_thumbnail (const PurpleXfer xfer, gsize len)
	Gets the thumbnail data for a transfer. More...

const gchar *	purple_xfer_get_thumbnail_mimetype (const PurpleXfer *xfer)
	Gets the mimetype of the thumbnail preview for a transfer. More...

void	purple_xfer_set_thumbnail (PurpleXfer xfer, gconstpointer thumbnail, gsize size, const gchar mimetype)
	Sets the thumbnail data for a transfer. More...

void	purple_xfer_prepare_thumbnail (PurpleXfer xfer, const gchar formats)
	Prepare a thumbnail for a transfer (if the UI supports it) will be no-op in case the UI doesn't implement thumbnail creation. More...

UI Registration Functions <br>
void *	purple_xfers_get_handle (void)
	Returns the handle to the file transfer subsystem. More...

void	purple_xfers_init (void)
	Initializes the file transfer subsystem.

void	purple_xfers_uninit (void)
	Uninitializes the file transfer subsystem.

void	purple_xfers_set_ui_ops (PurpleXferUiOps *ops)
	Sets the UI operations structure to be used in all purple file transfers. More...

PurpleXferUiOps *	purple_xfers_get_ui_ops (void)
	Returns the UI operations structure to be used in all purple file transfers. More...

Detailed Description

File Transfer API.

See also: File Transfer Signals

Definition in file ft.h.

Typedef Documentation

◆ PurpleXfer

typedef struct _PurpleXfer PurpleXfer

Data Structures

Definition at line 33 of file ft.h.

Enumeration Type Documentation

◆ PurpleXferStatusType

enum PurpleXferStatusType

The different states of the xfer.

Enumerator
PURPLE_XFER_STATUS_UNKNOWN	Unknown, the xfer may be null.
PURPLE_XFER_STATUS_NOT_STARTED	It hasn't started yet.
PURPLE_XFER_STATUS_ACCEPTED	Receive accepted, but destination file not selected yet.
PURPLE_XFER_STATUS_STARTED	purple_xfer_start has been called.
PURPLE_XFER_STATUS_DONE	The xfer completed successfully.
PURPLE_XFER_STATUS_CANCEL_LOCAL	The xfer was cancelled by us.
PURPLE_XFER_STATUS_CANCEL_REMOTE	The xfer was cancelled by the other end, or we couldn't connect.

Definition at line 54 of file ft.h.

◆ PurpleXferType

enum PurpleXferType

Types of file transfers.

Enumerator

PURPLE_XFER_UNKNOWN

Unknown file transfer type.

PURPLE_XFER_SEND

File sending.

PURPLE_XFER_RECEIVE

File receiving.

Definition at line 43 of file ft.h.

Function Documentation

◆ purple_xfer_add()

void purple_xfer_add ( PurpleXfer * xfer )

Adds a new file transfer to the list of file transfers.

Call this only if you are not using purple_xfer_start.

Parameters

xfer	The file transfer.

◆ purple_xfer_cancel_local()

void purple_xfer_cancel_local ( PurpleXfer * xfer )

Cancels a file transfer on the local end.

Parameters

xfer	The file transfer.

◆ purple_xfer_cancel_remote()

void purple_xfer_cancel_remote ( PurpleXfer * xfer )

Cancels a file transfer from the remote end.

Parameters

xfer	The file transfer.

◆ purple_xfer_conversation_write()

void purple_xfer_conversation_write	(	PurpleXfer *	xfer,
		char *	message,
		gboolean	is_error
	)

Displays a file transfer-related message in the conversation window.

This is a wrapper around purple_conversation_write

Parameters

xfer	The file transfer to which this message relates.
message	The message to display.
is_error	Is this an error message?.

◆ purple_xfer_end()

void purple_xfer_end ( PurpleXfer * xfer )

Ends a file transfer.

Parameters

xfer	The file transfer.

◆ purple_xfer_error()

void purple_xfer_error	(	PurpleXferType	type,
		PurpleAccount *	account,
		const char *	who,
		const char *	msg
	)

Displays a file transfer-related error message.

This is a wrapper around purple_notify_error(), which automatically specifies a title ("File transfer to <i>user</i> failed" or "File Transfer from <i>user</i> failed").

Parameters

type	The type of file transfer.
account	The account sending or receiving the file.
who	The user on the other end of the transfer.
msg	The message to display.

◆ purple_xfer_get_account()

PurpleAccount * purple_xfer_get_account ( const PurpleXfer * xfer )

Returns the account the file transfer is using.

Parameters

xfer	The file transfer.

Returns: The account.

◆ purple_xfer_get_bytes_remaining()

size_t purple_xfer_get_bytes_remaining ( const PurpleXfer * xfer )

Returns the number of bytes remaining to send or receive.

Parameters

xfer	The file transfer.

Returns: The number of bytes remaining.

◆ purple_xfer_get_bytes_sent()

size_t purple_xfer_get_bytes_sent ( const PurpleXfer * xfer )

Returns the number of bytes sent (or received) so far.

Parameters

xfer	The file transfer.

Returns: The number of bytes sent.

◆ purple_xfer_get_end_time()

time_t purple_xfer_get_end_time ( const PurpleXfer * xfer )

Returns the time the transfer of a file ended.

Parameters

xfer	The file transfer.

Returns: The time when the transfer ended.

Since: 2.4.0

◆ purple_xfer_get_filename()

const char * purple_xfer_get_filename ( const PurpleXfer * xfer )

Returns the name of the file being sent or received.

Parameters

xfer	The file transfer.

Returns: The filename.

◆ purple_xfer_get_local_filename()

const char * purple_xfer_get_local_filename ( const PurpleXfer * xfer )

Returns the file's destination filename,.

Parameters

xfer	The file transfer.

Returns: The destination filename.

◆ purple_xfer_get_local_port()

unsigned int purple_xfer_get_local_port ( const PurpleXfer * xfer )

Returns the local port number in the file transfer.

Parameters

xfer	The file transfer.

Returns: The port number on this end.

◆ purple_xfer_get_progress()

double purple_xfer_get_progress ( const PurpleXfer * xfer )

Returns the current percentage of progress of the transfer.

This is a number between 0 (0%) and 1 (100%).

Parameters

xfer	The file transfer.

Returns: The percentage complete.

◆ purple_xfer_get_remote_ip()

const char * purple_xfer_get_remote_ip ( const PurpleXfer * xfer )

Returns the remote IP address in the file transfer.

Parameters

xfer	The file transfer.

Returns: The IP address on the other end.

◆ purple_xfer_get_remote_port()

unsigned int purple_xfer_get_remote_port ( const PurpleXfer * xfer )

Returns the remote port number in the file transfer.

Parameters

xfer	The file transfer.

Returns: The port number on the other end.

◆ purple_xfer_get_remote_user()

const char * purple_xfer_get_remote_user ( const PurpleXfer * xfer )

Returns the name of the remote user.

Parameters

xfer	The file transfer.

Returns: The name of the remote user.

Since: 2.1.0

◆ purple_xfer_get_size()

size_t purple_xfer_get_size ( const PurpleXfer * xfer )

Returns the size of the file being sent or received.

Parameters

xfer	The file transfer.

Returns: The total size of the file.

◆ purple_xfer_get_start_time()

time_t purple_xfer_get_start_time ( const PurpleXfer * xfer )

Returns the time the transfer of a file started.

Parameters

xfer	The file transfer.

Returns: The time when the transfer started.

Since: 2.4.0

◆ purple_xfer_get_status()

PurpleXferStatusType purple_xfer_get_status ( const PurpleXfer * xfer )

Returns the status of the xfer.

Parameters

xfer	The file transfer.

Returns: The status.

◆ purple_xfer_get_thumbnail()

gconstpointer purple_xfer_get_thumbnail	(	const PurpleXfer *	xfer,
		gsize *	len
	)

Gets the thumbnail data for a transfer.

Parameters

xfer	The file transfer to get the thumbnail for
len	If not `NULL`, the length of the thumbnail data returned will be set in the location pointed to by this.

Returns: The thumbnail data, or NULL if there is no thumbnail

Since: 2.7.0

◆ purple_xfer_get_thumbnail_mimetype()

const gchar * purple_xfer_get_thumbnail_mimetype ( const PurpleXfer * xfer )

Gets the mimetype of the thumbnail preview for a transfer.

Parameters

xfer	The file transfer to get the mimetype for

Returns: The mimetype of the thumbnail, or NULL if not thumbnail is set

Since: 2.7.0

◆ purple_xfer_get_type()

PurpleXferType purple_xfer_get_type ( const PurpleXfer * xfer )

Returns the type of file transfer.

Parameters

xfer	The file transfer.

Returns: The type of the file transfer.

◆ purple_xfer_get_ui_ops()

PurpleXferUiOps * purple_xfer_get_ui_ops ( const PurpleXfer * xfer )

Returns the UI operations structure for a file transfer.

Parameters

xfer	The file transfer.

Returns: The UI operations structure.

◆ purple_xfer_is_canceled()

gboolean purple_xfer_is_canceled ( const PurpleXfer * xfer )

Returns true if the file transfer was cancelled.

Parameters

xfer	The file transfer.

Returns: Whether or not the transfer was cancelled. FIXME: This should be renamed using cancelled for 3.0.0.

◆ purple_xfer_is_completed()

gboolean purple_xfer_is_completed ( const PurpleXfer * xfer )

Returns the completed state for a file transfer.

Parameters

xfer	The file transfer.

Returns: The completed state.

◆ purple_xfer_new()

PurpleXfer * purple_xfer_new	(	PurpleAccount *	account,
		PurpleXferType	type,
		const char *	who
	)

Creates a new file transfer handle.

This is called by prpls. The handle starts with a ref count of 1, and this reference is owned by the core. The prpl normally does not need to purple_xfer_ref or unref.

Parameters

account	The account sending or receiving the file.
type	The type of file transfer.
who	The name of the remote user.

Returns: A file transfer handle.

◆ purple_xfer_prepare_thumbnail()

void purple_xfer_prepare_thumbnail	(	PurpleXfer *	xfer,
		const gchar *	formats
	)

Prepare a thumbnail for a transfer (if the UI supports it) will be no-op in case the UI doesn't implement thumbnail creation.

Parameters

xfer	The file transfer to create a thumbnail for
formats	A comma-separated list of mimetypes for image formats the protocols can use for thumbnails.

Since: 2.7.0

◆ purple_xfer_prpl_ready()

void purple_xfer_prpl_ready ( PurpleXfer * xfer )

Allows the prpl to signal it's ready 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.

Parameters

xfer	The file transfer which is ready.

Since: 2.6.0

◆ purple_xfer_read()

gssize purple_xfer_read	(	PurpleXfer *	xfer,
		guchar **	buffer
	)

Reads in data from a file transfer stream.

Parameters

xfer	The file transfer.
buffer	The buffer that will be created to contain the data.

Returns: The number of bytes read, or -1.

◆ purple_xfer_read_file()

gssize purple_xfer_read_file	(	PurpleXfer *	xfer,
		guchar *	buffer,
		gsize	size
	)

Writes chunk of file being sent.

Parameters

xfer	The file transfer.
buffer	The buffer to write the data to.
size	The size of buffer.

Returns: Number of bytes written (0 means, the device is busy), or -1 on failure.

Since: 2.11.0

◆ purple_xfer_ref()

void purple_xfer_ref ( PurpleXfer * xfer )

Increases the reference count on a PurpleXfer.

Please call purple_xfer_unref later.

Parameters

xfer	A file transfer handle.

◆ purple_xfer_request()

void purple_xfer_request ( PurpleXfer * xfer )

Requests confirmation for a file transfer from the user.

If receiving a file which is known at this point, this requests user to accept and save the file. If the filename is unknown (not set) this only requests user to accept the file transfer. In this case protocol must call this function again once the filename is available.

Parameters

xfer	The file transfer to request confirmation on.

◆ purple_xfer_request_accepted()

void purple_xfer_request_accepted	(	PurpleXfer *	xfer,
		const char *	filename
	)

Called if the user accepts the file transfer request.

Parameters

xfer	The file transfer.
filename	The filename.

◆ purple_xfer_request_denied()

void purple_xfer_request_denied ( PurpleXfer * xfer )

Called if the user rejects the file transfer request.

Parameters

xfer	The file transfer.

◆ purple_xfer_set_ack_fnc()

void purple_xfer_set_ack_fnc	(	PurpleXfer *	xfer,
		void()(PurpleXfer , const guchar *, size_t)	fnc
	)

Sets the acknowledge function for the file transfer.

Parameters

xfer	The file transfer.
fnc	The acknowledge function.

◆ purple_xfer_set_bytes_sent()

void purple_xfer_set_bytes_sent	(	PurpleXfer *	xfer,
		size_t	bytes_sent
	)

Sets the current working position in the active file transfer.

This can be used to jump backward in the file if the protocol detects that some bit of data needs to be resent or has been sent twice.

It's used for pausing and resuming an oscar file transfer.

Parameters

xfer	The file transfer.
bytes_sent	The new current position in the file. If we're sending a file then this is the byte that we will send. If we're receiving a file, this is the next byte that we expect to receive.

◆ purple_xfer_set_cancel_recv_fnc()

void purple_xfer_set_cancel_recv_fnc	(	PurpleXfer *	xfer,
		void()(PurpleXfer )	fnc
	)

Sets the cancel receive function for the file transfer.

Parameters

xfer	The file transfer.
fnc	The cancel receive function.

◆ purple_xfer_set_cancel_send_fnc()

void purple_xfer_set_cancel_send_fnc	(	PurpleXfer *	xfer,
		void()(PurpleXfer )	fnc
	)

Sets the cancel send function for the file transfer.

Parameters

xfer	The file transfer.
fnc	The cancel send function.

◆ purple_xfer_set_completed()

void purple_xfer_set_completed	(	PurpleXfer *	xfer,
		gboolean	completed
	)

Sets the completed state for the file transfer.

Parameters

xfer	The file transfer.
completed	The completed state.

◆ purple_xfer_set_end_fnc()

void purple_xfer_set_end_fnc	(	PurpleXfer *	xfer,
		void()(PurpleXfer )	fnc
	)

Sets the end transfer function for the file transfer.

Parameters

xfer	The file transfer.
fnc	The end transfer function.

◆ purple_xfer_set_filename()

void purple_xfer_set_filename	(	PurpleXfer *	xfer,
		const char *	filename
	)

Sets the filename for the file transfer.

Parameters

xfer	The file transfer.
filename	The filename.

◆ purple_xfer_set_init_fnc()

void purple_xfer_set_init_fnc	(	PurpleXfer *	xfer,
		void()(PurpleXfer )	fnc
	)

Sets the transfer initialization function for the file transfer.

This function is required, and must call purple_xfer_start() with the necessary parameters. This will be called if the file transfer is accepted by the user.

Parameters

xfer	The file transfer.
fnc	The transfer initialization function.

◆ purple_xfer_set_local_filename()

void purple_xfer_set_local_filename	(	PurpleXfer *	xfer,
		const char *	filename
	)

Sets the local filename for the file transfer.

Parameters

xfer	The file transfer.
filename	The filename

◆ purple_xfer_set_message()

void purple_xfer_set_message	(	PurpleXfer *	xfer,
		const char *	message
	)

Sets the filename for the file transfer.

Parameters

xfer	The file transfer.
message	The message.

◆ purple_xfer_set_read_fnc()

void purple_xfer_set_read_fnc	(	PurpleXfer *	xfer,
		gssize()(guchar , PurpleXfer )	fnc
	)

Sets the read function for the file transfer.

Parameters

xfer	The file transfer.
fnc	The read function.

◆ purple_xfer_set_request_denied_fnc()

void purple_xfer_set_request_denied_fnc	(	PurpleXfer *	xfer,
		void()(PurpleXfer )	fnc
	)

Sets the function to be called if the request is denied.

Parameters

xfer	The file transfer.
fnc	The request denied prpl callback.

◆ purple_xfer_set_size()

void purple_xfer_set_size	(	PurpleXfer *	xfer,
		size_t	size
	)

Sets the size of the file in a file transfer.

Parameters

xfer	The file transfer.
size	The size of the file.

◆ purple_xfer_set_start_fnc()

void purple_xfer_set_start_fnc	(	PurpleXfer *	xfer,
		void()(PurpleXfer )	fnc
	)

Sets the start transfer function for the file transfer.

Parameters

xfer	The file transfer.
fnc	The start transfer function.

◆ purple_xfer_set_thumbnail()

void purple_xfer_set_thumbnail	(	PurpleXfer *	xfer,
		gconstpointer	thumbnail,
		gsize	size,
		const gchar *	mimetype
	)

Sets the thumbnail data for a transfer.

Parameters

xfer	The file transfer to set the data for
thumbnail	A pointer to the thumbnail data, this will be copied
size	The size in bytes of the passed in thumbnail data
mimetype	The mimetype of the generated thumbnail

Since: 2.7.0

◆ purple_xfer_set_write_fnc()

void purple_xfer_set_write_fnc	(	PurpleXfer *	xfer,
		gssize()(const guchar , size_t, PurpleXfer *)	fnc
	)

Sets the write function for the file transfer.

Parameters

xfer	The file transfer.
fnc	The write function.

◆ purple_xfer_start()

void purple_xfer_start	(	PurpleXfer *	xfer,
		int	fd,
		const char *	ip,
		unsigned int	port
	)

Starts a file transfer.

Either fd must be specified or ip and port on a file receive transfer. On send, fd must be specified, and ip and port are ignored.

Prior to libpurple 2.6.0, passing '0' to fd was special-cased to allow the protocol plugin to facilitate the file transfer itself. As of 2.6.0, this is supported (for backward compatibility), but will be removed in libpurple 3.0.0. If a prpl detects that the running libpurple is running 2.6.0 or higher, it should use the invalid fd '-1'.

Parameters

xfer	The file transfer.
fd	The file descriptor for the socket.
ip	The IP address to connect to.
port	The port to connect to.

◆ purple_xfer_ui_ready()

void purple_xfer_ui_ready ( PurpleXfer * xfer )

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.

Parameters

xfer	The file transfer which is ready.

Since: 2.6.0

◆ purple_xfer_unref()

void purple_xfer_unref ( PurpleXfer * xfer )

Decreases the reference count on a PurpleXfer.

If the reference reaches 0, purple_xfer_destroy (an internal function) will destroy the xfer. It calls the ui destroy cb first. Since the core keeps a ref on the xfer, only an erroneous call to this function will destroy the xfer while still in use.

Parameters

xfer	A file transfer handle.

◆ purple_xfer_update_progress()

void purple_xfer_update_progress ( PurpleXfer * xfer )

Updates file transfer progress.

Parameters

xfer	The file transfer.

◆ purple_xfer_write()

gssize purple_xfer_write	(	PurpleXfer *	xfer,
		const guchar *	buffer,
		gsize	size
	)

Writes data to a file transfer stream.

Parameters

xfer	The file transfer.
buffer	The buffer to read the data from.
size	The number of bytes to write.

Returns: The number of bytes written, or -1.

◆ purple_xfer_write_file()

gboolean purple_xfer_write_file	(	PurpleXfer *	xfer,
		const guchar *	buffer,
		gsize	size
	)

Writes chunk of received file.

Parameters

xfer	The file transfer.
buffer	The buffer to read the data from.
size	The number of bytes to write.

Returns: TRUE on success, FALSE otherwise.

Since: 2.11.0

◆ purple_xfers_get_all()

GList * purple_xfers_get_all ( void )

Returns all xfers.

Returns: all current xfers with refs

◆ purple_xfers_get_handle()

void * purple_xfers_get_handle ( void )

Returns the handle to the file transfer subsystem.

Returns: The handle

◆ purple_xfers_get_ui_ops()

PurpleXferUiOps * purple_xfers_get_ui_ops ( void )

Returns the UI operations structure to be used in all purple file transfers.

Returns: The UI operations structure.

◆ purple_xfers_set_ui_ops()

void purple_xfers_set_ui_ops ( PurpleXferUiOps * ops )

Sets the UI operations structure to be used in all purple file transfers.

Parameters

ops	The UI operations structure.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ PurpleXfer

Enumeration Type Documentation

◆ PurpleXferStatusType

◆ PurpleXferType

Function Documentation

◆ purple_xfer_add()

◆ purple_xfer_cancel_local()

◆ purple_xfer_cancel_remote()

◆ purple_xfer_conversation_write()

◆ purple_xfer_end()

◆ purple_xfer_error()

◆ purple_xfer_get_account()

◆ purple_xfer_get_bytes_remaining()

◆ purple_xfer_get_bytes_sent()

◆ purple_xfer_get_end_time()

◆ purple_xfer_get_filename()

◆ purple_xfer_get_local_filename()

◆ purple_xfer_get_local_port()

◆ purple_xfer_get_progress()

◆ purple_xfer_get_remote_ip()

◆ purple_xfer_get_remote_port()

◆ purple_xfer_get_remote_user()

◆ purple_xfer_get_size()

◆ purple_xfer_get_start_time()

◆ purple_xfer_get_status()

◆ purple_xfer_get_thumbnail()

◆ purple_xfer_get_thumbnail_mimetype()

◆ purple_xfer_get_type()

◆ purple_xfer_get_ui_ops()

◆ purple_xfer_is_canceled()

◆ purple_xfer_is_completed()

◆ purple_xfer_new()

◆ purple_xfer_prepare_thumbnail()

◆ purple_xfer_prpl_ready()

◆ purple_xfer_read()

◆ purple_xfer_read_file()

◆ purple_xfer_ref()

◆ purple_xfer_request()

◆ purple_xfer_request_accepted()

◆ purple_xfer_request_denied()

◆ purple_xfer_set_ack_fnc()

◆ purple_xfer_set_bytes_sent()

◆ purple_xfer_set_cancel_recv_fnc()

◆ purple_xfer_set_cancel_send_fnc()

◆ purple_xfer_set_completed()

◆ purple_xfer_set_end_fnc()

◆ purple_xfer_set_filename()

◆ purple_xfer_set_init_fnc()

◆ purple_xfer_set_local_filename()

◆ purple_xfer_set_message()

◆ purple_xfer_set_read_fnc()

◆ purple_xfer_set_request_denied_fnc()

◆ purple_xfer_set_size()

◆ purple_xfer_set_start_fnc()

◆ purple_xfer_set_thumbnail()

◆ purple_xfer_set_write_fnc()

◆ purple_xfer_start()

◆ purple_xfer_ui_ready()

◆ purple_xfer_unref()

◆ purple_xfer_update_progress()

◆ purple_xfer_write()

◆ purple_xfer_write_file()

◆ purple_xfers_get_all()

◆ purple_xfers_get_handle()

◆ purple_xfers_get_ui_ops()

◆ purple_xfers_set_ui_ops()