Main Page   Alphabetical List   Compound List   File List   Compound Members   File Members  

data_movement_gass.hh File Reference

File movement service include file. More...

Go to the source code of this file.

Compounds

struct  ns__FileTask
struct  ns__string_vector
struct  tns__estimateTcpOptionsResponse
struct  tns__logDataTransferResponse
struct  tns__TcpOptions

Functions

int ns__DATACopyFile (char *source_URL, char *dest_URL, int max_retries, int use_parallel, char **response)
 Copies a single file.

int ns__DATACopyFileDefaults (char *source_URL, char *dest_URL, char **response)
 Copies a file using default parameters.

int ns__DATAMoveFile (char *source_URL, char *dest_URL, int max_retries, int use_parallel, char **response)
 Copies a file and then deletes the source.

int ns__DATAMoveFileDefaults (char *source_URL, char *dest_URL, char **response)
 Moves a file using default parameters.

int ns__DATADeleteFileDefaults (char *in_URL, char **response)
 Deletes a file.

int ns__isAlive (int dump, int *response)
 Test method.

int ns__getServiceDescription (void *dump, char **description)
 Returns a string description of the service.

int ns__DATATransferFile (int operation, char *source_URL, char *dest_URL, int max_retries, int use_parallel, char **response)
 Container method for Copy, Move and Delete.

int ns__DATAinit_CopyFile (char *source_URL, char *dest_URL, int max_retries, int use_parallel, struct ns__FileTask *response)
 Starts a non-blocking copy operation.

int ns__DATAinit_MoveFile (char *source_URL, char *dest_URL, int max_retries, int use_parallel, struct ns__FileTask *response)
 Starts a non-blocking move operation.

int ns__DATAinit_DeleteFile (char *source_URL, struct ns__FileTask *response)
 Starts a non-blocking delete operation.

int ns__DATAinit_TransferFile (int operation, char *source_URL, char *dest_URL, int max_retries, int use_parallel, struct ns__FileTask *response)
 container method for non-blocking Copy, Move and Delete.

int ns__DATArestartFileTask (xsd__long id, struct ns__FileTask *response)
 Restarts a stopped or otherwise interrupted copy or move operation.

int ns__DATAgetFileTask (xsd__long id, struct ns__FileTask *response)
 Returns information about the status of a transfer.

int ns__DATAwaitFileTask (xsd__long id, struct ns__FileTask *response)
 Blocks and waits for a transfer to complete.

int ns__DATAstopFileTask (xsd__long id, struct ns__FileTask *response)
 Stops a copy or move operation (blocking).

int ns__DATAdeleteFileTask (xsd__long id, int *response)
 Deletes information about a transfer.

int ns__DATAmultipleCopy (struct ns__string_vector in_URLs, char **response)
 Copies multiple gridftp files.


Detailed Description

File movement service include file.

GridLab File movement service include file used for generating server and client stubs with gsoap

Author : Andrei Hutanu, ZIB

Definition in file data_movement_gass.hh.


Function Documentation

int ns__DATACopyFile char *    source_URL,
char *    dest_URL,
int    max_retries,
int    use_parallel,
char **    response
 

Copies a single file.

This method blocks until the operation is completed (with success or failure)

Parameters:
source_URL  the URL of the source file
dest_URL  the URL of the destination
max_retries  the maximum number of restarts to be tried before a complete failure(momentarily unused)
use_parallel  true if the usage of parallel streams is desired
response  return parameter
Returns:
a string containing a numeric error code followed by a human-readable description

int ns__DATACopyFileDefaults char *    source_URL,
char *    dest_URL,
char **    response
 

Copies a file using default parameters.

This method blocks until the operation is completed (with success or failure) The defaults are currently 0 for max_retries and 1 for use_parallel.

Parameters:
source_URL  the URL of the source file
dest_URL  the URL of the destination
response  return parameter
See also:
ns__DATACopyFile
Returns:
a string containing a numeric error code followed by a human-readable description

int ns__DATADeleteFileDefaults char *    in_URL,
char **    response
 

Deletes a file.

This method blocks until the operation is completed (with success or failure)

Parameters:
in_URL  the URL of the file
response  return parameter
Returns:
a string containing a numeric error code followed by a human-readable description

int ns__DATAdeleteFileTask xsd__long    id,
int *    response
 

Deletes information about a transfer.

The transfer should have been initiated with one of the init methods. This method stops the transfer if in prgress. After delete is called, the information about the transfer will be erased and the id will be reused. This method should always be called after the transfer is completed so that the memory on the machine that runs the service can be freed.

Parameters:
id  the transfer identifier
response  the return parameter
Returns:
integer containing error code

int ns__DATAgetFileTask xsd__long    id,
struct ns__FileTask   response
 

Returns information about the status of a transfer.

The transfer should have been initiated with one of the init methods. The method returns immediately.

Parameters:
id  the transfer identifier
response  the return parameter
Returns:
a handle containing data on the transfer status

int ns__DATAinit_CopyFile char *    source_URL,
char *    dest_URL,
int    max_retries,
int    use_parallel,
struct ns__FileTask   response
 

Starts a non-blocking copy operation.

Non-blocking operations have similar parameters with the blocking versions. Every non-bocking operation is handled by a separate thread.

See also:
ns__DATACopyFile
Parameters:
response  the return parameter
Returns:
a handle containing the transfer id and other data on the transfer status

int ns__DATAinit_DeleteFile char *    source_URL,
struct ns__FileTask   response
 

Starts a non-blocking delete operation.

See also:
ns__DATAinit_CopyFile
Parameters:
source_URL  the URL of the file
response  the return parameter
Returns:
a handle containing the transfer id and other data on the transfer status

int ns__DATAinit_MoveFile char *    source_URL,
char *    dest_URL,
int    max_retries,
int    use_parallel,
struct ns__FileTask   response
 

Starts a non-blocking move operation.

See also:
ns__DATAMoveFile , ns__DATAinit_CopyFile
Parameters:
response  the return parameter
Returns:
a handle containing the transfer id and other data on the transfer status

int ns__DATAinit_TransferFile int    operation,
char *    source_URL,
char *    dest_URL,
int    max_retries,
int    use_parallel,
struct ns__FileTask   response
 

container method for non-blocking Copy, Move and Delete.

Parameters:
operation  0 for copy, 1 for move and 2 for delete
source_URL  the URL of the source file
dest_URL  the URL of the destination (ignored for delete)
max_retries  the maximum number of restarts to be tried before a complete failure(momentarily unused)
use_parallel  true if the usage of parallel streams is desired at copy (ignored for delete)
response  the return parameter
See also:
ns__DATATransferFile , ns__DATAinit_CopyFile
Returns:
a handle containing the transfer id and other data on the transfer status

int ns__DATAMoveFile char *    source_URL,
char *    dest_URL,
int    max_retries,
int    use_parallel,
char **    response
 

Copies a file and then deletes the source.

This method blocks until the operation is completed (with success or failure)

Parameters:
source_URL  the URL of the source file
dest_URL  the URL of the destination
max_retries  the maximum number of restarts to be tried before a complete failure(momentarily unused)
use_parallel  true if the usage of parallel streams is desired at copy
response  return parameter
Returns:
a string containing a numeric error code followed by a human-readable description

int ns__DATAMoveFileDefaults char *    source_URL,
char *    dest_URL,
char **    response
 

Moves a file using default parameters.

This method blocks until the operation is completed (with success or failure) The defaults are currently 0 for max_retries and 1 for use_parallel.

Parameters:
source_URL  the URL of the source file
dest_URL  the URL of the destination
response  return parameter
See also:
ns__DATAMoveFile
Returns:
a string containing a numeric error code followed by a human-readable description

int ns__DATAmultipleCopy struct ns__string_vector    in_URLs,
char **    response
 

Copies multiple gridftp files.

This method is useful for copying a large number of small gridftp files The service will cache the connections to the gridftp servers between he transfers so that the authentification overhead occurs only once.

Parameters:
in_URLs  vector containing the URLs stored in this order : source1, destination1, source2, destination2 ...
response  the return parameter
Returns:
a string containing a numeric error code followed by a human-readable description

int ns__DATArestartFileTask xsd__long    id,
struct ns__FileTask   response
 

Restarts a stopped or otherwise interrupted copy or move operation.

The transfer should have been initiated with one of the init methods. If the operation was interrupted with stopFileTask or by a transient network error and the service was able to save a restart marker before that, the operation is resumed using this call. If the transfer was not interupted (it failed from the beginning) or it was interrupted too early (no restart marker was saved) then the transfer cannot be resumed.

Parameters:
id  the transfer identifier
response  the return parameter
Returns:
a handle containing the transfer id and other data on the transfer status

int ns__DATAstopFileTask xsd__long    id,
struct ns__FileTask   response
 

Stops a copy or move operation (blocking).

The transfer should have been initiated with one of the init methods. This methods interrupts (if possible) the transfer. Useful for large file transfers. The operation may be resumed using restartFileTask

Parameters:
id  the transfer identifier
response  the return parameter
Returns:
a handle containing data on the transfer status

int ns__DATATransferFile int    operation,
char *    source_URL,
char *    dest_URL,
int    max_retries,
int    use_parallel,
char **    response
 

Container method for Copy, Move and Delete.

This method makes calls to Copy, Move or Delete depending on the operation type. The other parameters are forwarded This method blocks until the operation is completed (with success or failure)

Parameters:
operation  0 for copy, 1 for move and 2 for delete
source_URL  the URL of the source file
dest_URL  the URL of the destination (ignored for delete)
max_retries  the maximum number of restarts to be tried before a complete failure(momentarily unused)
use_parallel  true if the usage of parallel streams is desired at copy (ignored for delete)
response  return prameter
See also:
ns__DATACopyFile , ns__DATAMoveFile , ns__DATADeleteFileDefaults
Returns:
a string containing a numeric error code followed by a human-readable description

int ns__DATAwaitFileTask xsd__long    id,
struct ns__FileTask   response
 

Blocks and waits for a transfer to complete.

The transfer should have been initiated with one of the init methods. This method waits for that transfer to end or if the transfer was already finished it returns immediately.

Parameters:
id  the transfer identifier
response  the return parameter
Returns:
a handle containing data on the transfer status

int ns__getServiceDescription void *    dump,
char **    description
 

Returns a string description of the service.

Parameters:
dump  unused
description  return parameter

int ns__isAlive int    dump,
int *    response
 

Test method.

Returns 1 (used to see if the service is running)

Parameters:
dump  unused
response  return parameter


Generated on Fri Jan 23 18:55:42 2004 for File Movement by doxygen1.2.18