<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>CERN GFAL 2.0: /builddir/build/BUILD/gfal2-2.1.1/src/transfer/gfal_transfer.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">CERN GFAL 2.0  <span id="projectnumber">2.0.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_59d128fb766534d0ff9e97832ccaaa5c.html">transfer</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">gfal_transfer.h File Reference</div> </div> </div><!--header--> <div class="contents"> <div class="textblock"><code>#include <<a class="el" href="gfal__transfer__types_8h.html">transfer/gfal_transfer_types.h</a>></code><br/> <code>#include <<a class="el" href="gfal__global_8h.html">global/gfal_global.h</a>></code><br/> <code>#include <<a class="el" href="gfal__logger_8h.html">logger/gfal_logger.h</a>></code><br/> <code>#include <<a class="el" href="gfal__constants_8h.html">common/gfal_constants.h</a>></code><br/> </div><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga3a920bfdd1ba2b468bbfb17c197a7773"><td class="memItemLeft" align="right" valign="top"><a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga3a920bfdd1ba2b468bbfb17c197a7773">gfalt_params_handle_new</a> (GError **err)</td></tr> <tr class="memitem:gac9d82ac24c51b120235fdf5c5566e0f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gac9d82ac24c51b120235fdf5c5566e0f1">gfalt_params_handle_delete</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, GError **err)</td></tr> <tr class="memitem:gac9887f59ce3924a480c2059f07af19e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gac9887f59ce3924a480c2059f07af19e2">gfalt_params_handle_copy</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, GError **err)</td></tr> <tr class="memitem:ga7cfa7e526d31a538bd3a2140acc4efd5"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga7cfa7e526d31a538bd3a2140acc4efd5">gfalt_set_timeout</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, guint64 timeout, GError **err)</td></tr> <tr class="memitem:ga9b484a7b92471c63aec715844f513650"><td class="memItemLeft" align="right" valign="top">guint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga9b484a7b92471c63aec715844f513650">gfalt_get_timeout</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> handle, GError **err)</td></tr> <tr class="memitem:ga5be8df44731e60bcb8026ff8ceb122c0"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga5be8df44731e60bcb8026ff8ceb122c0">gfalt_set_nbstreams</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, guint nbstreams, GError **err)</td></tr> <tr class="memitem:ga65db883945fbf81755ba3c8f962e68fd"><td class="memItemLeft" align="right" valign="top">guint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga65db883945fbf81755ba3c8f962e68fd">gfalt_get_nbstreams</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, GError **err)</td></tr> <tr class="memitem:ga8d25030958340468714f449a6811b8d8"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga8d25030958340468714f449a6811b8d8">gfalt_set_tcp_buffer_size</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, guint64 tcp_buffer_size, GError **err)</td></tr> <tr class="memitem:ga79f0c7d8237dc71502f868fe316c60be"><td class="memItemLeft" align="right" valign="top">guint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga79f0c7d8237dc71502f868fe316c60be">gfalt_get_tcp_buffer_size</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, GError **err)</td></tr> <tr class="memitem:ga80052ae0cbcd675d6b9dbc6e52d1d39d"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga80052ae0cbcd675d6b9dbc6e52d1d39d">gfalt_set_local_transfer_perm</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, gboolean local_transfer_status, GError **err)</td></tr> <tr class="memitem:gac0996fd282e7f5fb2724b1c2ccd6eaa3"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gac0996fd282e7f5fb2724b1c2ccd6eaa3">gfalt_get_local_transfer_perm</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, GError **err)</td></tr> <tr class="memitem:ga6c953c9dc8b4e7e1ef4335a8ca97b00d"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga6c953c9dc8b4e7e1ef4335a8ca97b00d">gfalt_set_src_spacetoken</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, const char *srm_spacetoken, GError **err)</td></tr> <tr class="memitem:gac02a6366442f0326c9326c68a1543df1"><td class="memItemLeft" align="right" valign="top">gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gac02a6366442f0326c9326c68a1543df1">gfalt_get_src_spacetoken</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, GError **err)</td></tr> <tr class="memitem:ga741efddf91c5ff486902489738a26d5f"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga741efddf91c5ff486902489738a26d5f">gfalt_set_dst_spacetoken</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, const char *srm_spacetoken, GError **err)</td></tr> <tr class="memitem:ga35d525febe7b52493e1f7ce99cb10910"><td class="memItemLeft" align="right" valign="top">gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga35d525febe7b52493e1f7ce99cb10910">gfalt_get_dst_spacetoken</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, GError **err)</td></tr> <tr class="memitem:gacae340e46571e376a0332b9ccc667ec0"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gacae340e46571e376a0332b9ccc667ec0">gfalt_set_replace_existing_file</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, gboolean replace, GError **err)</td></tr> <tr class="memitem:gadce475524924b8a94b10f2eea9bd24f6"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gadce475524924b8a94b10f2eea9bd24f6">gfalt_get_replace_existing_file</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, GError **err)</td></tr> <tr class="memitem:gad6033e3377b7af6d9a2c73ad756d507f"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gad6033e3377b7af6d9a2c73ad756d507f">gfalt_set_strict_copy_mode</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, gboolean strict_mode, GError **err)</td></tr> <tr class="memitem:gad41555970a459a0c1cabd57e48142d78"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gad41555970a459a0c1cabd57e48142d78">gfalt_get_strict_copy_mode</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, GError **err)</td></tr> <tr class="memitem:gae628a4df4349ea49a1a447fd8c1c732f"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gae628a4df4349ea49a1a447fd8c1c732f">gfalt_set_checksum_check</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, gboolean value, GError **err)</td></tr> <tr class="memitem:ga5778e48c6287c4c5161ac74d163cf118"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga5778e48c6287c4c5161ac74d163cf118">gfalt_get_checksum_check</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, GError **err)</td></tr> <tr class="memitem:ga7660df2fc80a0b4adc4173a60bae2830"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga7660df2fc80a0b4adc4173a60bae2830">gfalt_set_user_defined_checksum</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> param, const gchar *chktype, const gchar *checksum, GError **err)</td></tr> <tr class="memitem:ga0b0b6537f1e8f3d2bfa8b78965cdb178"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga0b0b6537f1e8f3d2bfa8b78965cdb178">gfalt_get_user_defined_checksum</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, gchar *chktype_buff, size_t chk_type_len, gchar *checksum_buff, size_t checksum_len, GError **err)</td></tr> <tr class="memitem:gab0f30781b89553d74cb7f4f123b96518"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gab0f30781b89553d74cb7f4f123b96518">gfalt_set_create_parent_dir</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, gboolean value, GError **err)</td></tr> <tr class="memitem:ga85a1e446f19d7d88dbad735f2fe14fb8"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga85a1e446f19d7d88dbad735f2fe14fb8">gfalt_get_create_parent_dir</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, GError **err)</td></tr> <tr class="memitem:gad63addad59916c3e9befc91714b19dc5"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gad63addad59916c3e9befc91714b19dc5">gfalt_set_user_data</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, gpointer user_data, GError **err)</td></tr> <tr class="memitem:gaf0ef0fa8fbc6a4d50710a155cc7af56a"><td class="memItemLeft" align="right" valign="top">gpointer </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gaf0ef0fa8fbc6a4d50710a155cc7af56a">gfalt_get_user_data</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a>, GError **err)</td></tr> <tr class="memitem:ga11538037ecc7aef83ad0692f764b3fbd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga11538037ecc7aef83ad0692f764b3fbd"></a> gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga11538037ecc7aef83ad0692f764b3fbd">gfalt_set_monitor_callback</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, <a class="el" href="gfal__transfer__types_8h.html#adfdf0b0dc239a4364a4a7d73d34d9ea6">gfalt_monitor_func</a> callback, GError **err)</td></tr> <tr class="memdesc:ga11538037ecc7aef83ad0692f764b3fbd"><td class="mdescLeft"> </td><td class="mdescRight">define a callback for monitoring the current transfer The default value is NULL and no monitoring will occures <br/></td></tr> <tr class="memitem:gadf4a63465bd2dd7041a480899e313cbe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadf4a63465bd2dd7041a480899e313cbe"></a> <a class="el" href="gfal__transfer__types_8h.html#adfdf0b0dc239a4364a4a7d73d34d9ea6">gfalt_monitor_func</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gadf4a63465bd2dd7041a480899e313cbe">gfalt_get_monitor_callback</a> (<a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, GError **err)</td></tr> <tr class="memdesc:gadf4a63465bd2dd7041a480899e313cbe"><td class="mdescLeft"> </td><td class="mdescRight">get the current monitor callback <br/></td></tr> <tr class="memitem:gaa12918b77e12438772e94e1e953be201"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gaa12918b77e12438772e94e1e953be201">gfalt_copy_file</a> (<a class="el" href="gfal__global_8h.html#a3653ff2b8bf7affda4dfcf66af8d1632">gfal2_context_t</a> context, <a class="el" href="gfal__transfer__types_8h.html#a7360817428e9f8ba4dba2084be040f8e">gfalt_params_t</a> params, const char *src, const char *dst, GError **err)</td></tr> <tr class="memdesc:gaa12918b77e12438772e94e1e953be201"><td class="mdescLeft"> </td><td class="mdescRight">copy function start a synchronous copy of the file <a href="group__transfer__group.html#gaa12918b77e12438772e94e1e953be201"></a><br/></td></tr> <tr class="memitem:ga445c9f02e7e823563a8c6af80496de3a"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga445c9f02e7e823563a8c6af80496de3a">gfalt_copy_cancel</a> (<a class="el" href="gfal__transfer__types_8h.html#a9076a53db49d5a1a46f8937a39fe03ce">gfalt_transfer_status_t</a>, GError **err)</td></tr> <tr class="memitem:gad857e4858e648b86544d8275880ee545"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#gad857e4858e648b86544d8275880ee545">gfalt_copy_get_status</a> (<a class="el" href="gfal__transfer__types_8h.html#a9076a53db49d5a1a46f8937a39fe03ce">gfalt_transfer_status_t</a>, GError **err)</td></tr> <tr class="memitem:ga33f54dbc69415ef31d2753812c249758"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga33f54dbc69415ef31d2753812c249758">gfalt_copy_get_average_baudrate</a> (<a class="el" href="gfal__transfer__types_8h.html#a9076a53db49d5a1a46f8937a39fe03ce">gfalt_transfer_status_t</a>, GError **err)</td></tr> <tr class="memitem:ga99c3c355f2c1ffac905e4405867dc0b5"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga99c3c355f2c1ffac905e4405867dc0b5">gfalt_copy_get_instant_baudrate</a> (<a class="el" href="gfal__transfer__types_8h.html#a9076a53db49d5a1a46f8937a39fe03ce">gfalt_transfer_status_t</a>, GError **err)</td></tr> <tr class="memitem:ga46484334589680b0099d9431588db0e2"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga46484334589680b0099d9431588db0e2">gfalt_copy_get_bytes_transfered</a> (<a class="el" href="gfal__transfer__types_8h.html#a9076a53db49d5a1a46f8937a39fe03ce">gfalt_transfer_status_t</a>, GError **err)</td></tr> <tr class="memitem:ga14302524085e37cdb5f77c97915bb5f3"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transfer__group.html#ga14302524085e37cdb5f77c97915bb5f3">gfalt_copy_get_elapsed_time</a> (<a class="el" href="gfal__transfer__types_8h.html#a9076a53db49d5a1a46f8937a39fe03ce">gfalt_transfer_status_t</a>, GError **err)</td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>gfal2 API for file transfers . This API provide :</p> <ul> <li>third party file transfers</li> <li>monitoring of the transfer</li> <li>flow control for the transfer <dl class="section author"><dt>Author:</dt><dd>Adrien Devresse </dd></dl> </li> </ul> </div></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.1.1 </small></address> </body> </html>