/builddir/build/BUILD/gfal2-2.0.0/src/transfer/gfal_transfer.h File Reference

#include <transfer/gfal_transfer_types.h>
#include <global/gfal_global.h>
#include <common/gfal_constants.h>

Go to the source code of this file.

Functions

gfalt_params_t gfalt_params_handle_new (GError **err)
 initiate a new parameter handle
void gfalt_params_handle_delete (gfalt_params_t params, GError **err)
int gfalt_set_timeout (gfalt_params_t, unsigned long timeout, GError **err)
int gfalt_set_nbstreams (gfalt_params_t, unsigned long nbstreams, GError **err)
int gfalt_set_replace_existing_file (gfalt_params_t, gboolean replace, GError **err)
int gfalt_set_offset_from_source (gfalt_params_t, off_t offset, GError **err)
int gfalt_set_user_data (gfalt_params_t, gpointer user_data, GError **err)
int gfalt_set_uuid (gfalt_params_t, uuid_t uuid, GError **err)
int gfalt_set_callback_mperiod (gfalt_params_t, unsigned int mtime, GError **err)
void gfalt_set_monitor_tfr (gfalt_params_t params, gfalt_monitor_tfr callback)
 define a callback for monitoring the current transfer The default value is NULL and no monitoring will occures
int gfalt_copy_file (gfal_context_t context, gfalt_params_t ph, const char *src, const char *dst, GError **err)
 copy function start a synchronous copy of the file
int gfalt_copy_cancel (gfalt_transfer_status_t, GError **err)
int gfalt_copy_pause (gfalt_transfer_status_t, GError **err)
int gfalt_copy_resume (gfalt_transfer_status_t, GError **err)
int gfalt_copy_get_status (gfalt_transfer_status_t, GError **err)
int 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)


Detailed Description

gfal API for file transfers of the gfal2_transfer shared library. This API provide :

Function Documentation

int gfalt_copy_cancel ( gfalt_transfer_status_t  ,
GError **  err 
)

cancel the current file copy

int gfalt_copy_file ( gfal_context_t  context,
gfalt_params_t  ph,
const char *  src,
const char *  dst,
GError **  err 
)

copy function start a synchronous copy of the file

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

int 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

int gfalt_copy_pause ( gfalt_transfer_status_t  ,
GError **  err 
)

temporary put the transfer in pause

int gfalt_copy_resume ( gfalt_transfer_status_t  ,
GError **  err 
)

resume a transfer in pause

void gfalt_params_handle_delete ( gfalt_params_t  params,
GError **  err 
)

delete a created parameters handle

int gfalt_set_callback_mperiod ( gfalt_params_t  ,
unsigned int  mtime,
GError **  err 
)

set the minimum among of time between two calls of gfalt_monitor_tfr

int gfalt_set_nbstreams ( gfalt_params_t  ,
unsigned long  nbstreams,
GError **  err 
)

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

int 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

int 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

int gfalt_set_timeout ( gfalt_params_t  ,
unsigned long  timeout,
GError **  err 
)

define the maximum time acceptable for the file tranfer

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

set the user_data pointer for statefull usages.

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

set the uid of the transfer


Generated on Wed May 16 16:45:58 2012 for CERN org.glite.Gfal by  doxygen 1.4.7