~ubuntu-branches/ubuntu/vivid/cctools/vivid

« back to all changes in this revision

Viewing changes to chirp/src/chirp_recursive.h

  • Committer: Bazaar Package Importer
  • Author(s): Michael Hanke
  • Date: 2011-05-07 09:05:00 UTC
  • Revision ID: james.westby@ubuntu.com-20110507090500-lqpmdtwndor6e7os
Tags: upstream-3.3.2
ImportĀ upstreamĀ versionĀ 3.3.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
Copyright (C) 2008- The University of Notre Dame
 
3
This software is distributed under the GNU General Public License.
 
4
See the file COPYING for details.
 
5
*/
 
6
 
 
7
#ifndef CHIRP_RECURSIVE_H
 
8
#define CHIRP_RECURSIVE_H
 
9
 
 
10
#include "int_sizes.h"
 
11
 
 
12
/** @file chirp_recursive.h
 
13
A high level interface to put and get large directories trees to and from Chirp servers.
 
14
*/
 
15
 
 
16
/** Recursively put a file or directory to a Chirp server.
 
17
Relies on @ref chirp_reli_putfile and similar calls
 
18
to handle a number of failure cases.
 
19
@param hostport The host and port of the Chirp server.
 
20
@param sourcepath The path to the local file or directory to send.
 
21
@param targetpath The name to give the file or directory on the server.
 
22
@param stoptime The absolute time at which to abort.
 
23
@return On success, returns the sum of file bytes transferred.  On failure, returns less than zero and sets errno appropriately.
 
24
*/
 
25
 
 
26
INT64_T chirp_recursive_put( const char *hostport, const char *sourcepath, const char *targetpath, time_t stoptime );
 
27
 
 
28
/** Recursively get a file or directory from a Chirp server.
 
29
Relies on @ref chirp_reli_getfile and similar calls
 
30
to handle a number of failure cases.
 
31
@param hostport The host and port of the Chirp server.
 
32
@param sourcepath The path to the remote file or directory to get.
 
33
@param targetpath The name to give the local file or directory.
 
34
@param stoptime The absolute time at which to abort.
 
35
@return On success, returns the sum of file bytes transferred.  On failure, returns less than zero and sets errno appropriately.
 
36
*/
 
37
 
 
38
INT64_T chirp_recursive_get( const char *hostport, const char *sourcepath, const char *targetpath, time_t stoptime );
 
39
 
 
40
#endif