File Transfer API

Functions
gfalt_params_t	gfalt_params_handle_new (GError **err)
void	gfalt_params_handle_delete (gfalt_params_t params, GError **err)
gint	gfalt_set_timeout (gfalt_params_t, guint64 timeout, GError **err)
guint64	gfalt_get_timeout (gfalt_params_t handle, GError **err)
gint	gfalt_set_nbstreams (gfalt_params_t, guint nbstreams, GError **err)
guint	gfalt_get_nbstreams (gfalt_params_t params, GError **err)
gint	gfalt_set_src_spacetoken (gfalt_params_t params, const char *srm_spacetoken, GError **err)
gchar *	gfalt_get_src_spacetoken (gfalt_params_t params, GError **err)
gint	gfalt_set_dst_spacetoken (gfalt_params_t params, const char *srm_spacetoken, GError **err)
gchar *	gfalt_get_dst_spacetoken (gfalt_params_t params, GError **err)
gint	gfalt_set_replace_existing_file (gfalt_params_t, gboolean replace, GError **err)
gboolean	gfalt_get_replace_existing_file (gfalt_params_t, GError **err)
gint	gfalt_set_offset_from_source (gfalt_params_t, off_t offset, GError **err)
gint	gfalt_set_user_data (gfalt_params_t, gpointer user_data, GError **err)
gint	gfalt_set_uuid (gfalt_params_t, uuid_t uuid, GError **err)
gint	gfalt_set_callback_mperiod (gfalt_params_t, guint mtime, GError **err)
void	gfalt_set_monitor_callback (gfalt_params_t params, gfalt_monitor_func callback)
	define a callback for monitoring the current transfer The default value is NULL and no monitoring will occures
int	gfalt_copy_file (gfal2_context_t context, gfalt_params_t params, const char *src, const char *dst, GError **err)
	copy function start a synchronous copy of the file
gint	gfalt_copy_cancel (gfalt_transfer_status_t, GError **err)
gint	gfalt_copy_get_status (gfalt_transfer_status_t, GError **err)
gint	gfalt_copy_get_baudrate (gfalt_transfer_status_t, GError **err)
size_t	gfalt_copy_get_bytes_transfered (gfalt_transfer_status_t, GError **err)
time_t	gfalt_copy_get_elapsed_time (gfalt_transfer_status_t, GError **err)

---

Function Documentation

gint gfalt_copy_cancel	(	gfalt_transfer_status_t	,
		GError **	err
	)

cancel the current file copy

int gfalt_copy_file	(	gfal2_context_t	context,
		gfalt_params_t	params,
		const char *	src,
		const char *	dst,
		GError **	err
	)

copy function start a synchronous copy of the file

Parameters:

context	: gfal context
params	parameter handle ( gfalt_parameters_new )
src	source URL supported by GFAL
dst	destination URL supported by GFAL

gint gfalt_copy_get_baudrate	(	gfalt_transfer_status_t	,
		GError **	err
	)

get an estimation of the baudrate

size_t gfalt_copy_get_bytes_transfered	(	gfalt_transfer_status_t	,
		GError **	err
	)

get the current number of bytes transfered

time_t gfalt_copy_get_elapsed_time	(	gfalt_transfer_status_t	,
		GError **	err
	)

get the elapsed tiem since the call to gfalt_copy_file

gchar* gfalt_get_dst_spacetoken	(	gfalt_params_t	params,
		GError **	err
	)

get the destination spacetoken for SRM transfers

guint gfalt_get_nbstreams	(	gfalt_params_t	params,
		GError **	err
	)

get the maximum number of parallels streams to use for the transfer

gboolean gfalt_get_replace_existing_file	(	gfalt_params_t	,
		GError **	err
	)

get the policy in case of destination file already existing ( replace or cancel ) default : cancel

gchar* gfalt_get_src_spacetoken	(	gfalt_params_t	params,
		GError **	err
	)

get the source spacetoken for SRM transfers

guint64 gfalt_get_timeout	(	gfalt_params_t	handle,
		GError **	err
	)

get the maximum connexion timeout

void gfalt_params_handle_delete	(	gfalt_params_t	params,
		GError **	err
	)

delete a created parameters handle

gfalt_params_t gfalt_params_handle_new

(

GError **

err

)

initiate a new parameter handle

gint gfalt_set_callback_mperiod	(	gfalt_params_t	,
		guint	mtime,
		GError **	err
	)

set the minimum among of time between two calls of gfalt_monitor_tfr

gint gfalt_set_dst_spacetoken	(	gfalt_params_t	params,
		const char *	srm_spacetoken,
		GError **	err
	)

set the destination spacetoken for SRM transfers

gint gfalt_set_nbstreams	(	gfalt_params_t	,
		guint	nbstreams,
		GError **	err
	)

define the maximum number of parallels connexion to use for the file tranfer

gint gfalt_set_offset_from_source	(	gfalt_params_t	,
		off_t	offset,
		GError **	err
	)

default offset for the copy of the file ( retry function ) default : 0

gint gfalt_set_replace_existing_file	(	gfalt_params_t	,
		gboolean	replace,
		GError **	err
	)

set the policy in case of destination file already existing ( replace or cancel ) default : cancel

gint gfalt_set_src_spacetoken	(	gfalt_params_t	params,
		const char *	srm_spacetoken,
		GError **	err
	)

set the source spacetoken for SRM transfers

gint gfalt_set_timeout	(	gfalt_params_t	,
		guint64	timeout,
		GError **	err
	)

define the maximum time acceptable for the file tranfer

gint gfalt_set_user_data	(	gfalt_params_t	,
		gpointer	user_data,
		GError **	err
	)

set the user_data pointer for statefull usages.

gint gfalt_set_uuid	(	gfalt_params_t	,
		uuid_t	uuid,
		GError **	err
	)

set the uid of the transfer