Aspera Developer Documentation
Public Member Functions | Public Attributes | List of all members
XferParams Struct Reference

A structure of transfer parameters. More...

Public Member Functions

 XferParams ()
 Default constructor.
 
 XferParams (const XferParams &xp)
 Copy constructor.
 

Public Attributes

unsigned short tcp_port
 The TCP (SSH) port pertaining to the transfer. Default: 22.
 
unsigned short udp_port
 The UDP (FASP) port pertaining to the transfer. Default: 33001.
 
u_int64_t target_rate
 The target transfer rate. Default: 10000.
 
u_int64_t min_rate
 The min transfer rate. Default: 0.
 
bool auto_bwidth_discovery
 
fasp_version_e fasp_version
 FASP Protocol Version. Defaults to FASP2, if not set.
 
encryption_type_e encryption
 Enable encryption ("None" or "AES-128"). Default: AES-128.
 
policy_e policy
 The transfer rate policy. Default: POLICY_ADAPTIVE.
 
bool create_dirs
 Create target path directories if they don't exist. Default: false.
 
resume_type_e resume_check
 Incomplete transfer resume policy. Default: RESUME_SPARSE_CHKSUM.
 
char const * token
 Security token.
 
char const * cookie
 Input cookie for server side consumption.
 
content_protect_e content_protection
 
char const * content_protect_passwd
 Password for encryption at rest.
 
bool pre_calculate_job_size
 Pre-calculate full job size. Default: false.
 
char const * license
 License key to be used for this transfer (Do NOT include the hyphens)
 
char const * fasp_log_path
 Path to the location of FASP transfer logs.
 
char const * fasp_remote_log_path
 Path to the location of FASP transfer logs on the remote machine.
 
unsigned long dgram_size
 Datagram size for FASP.
 
unsigned long rexmsg_size
 Retransmission request size. Capped at 1440 bytes.
 
unsigned long write_blk_size
 Write block size in bytes.
 
unsigned long read_blk_size
 Read block size in bytes.
 
bool preserve_dates
 Preserve file timestamp.
 
bool persist
 
bool preserve_user_id
 Preserve file owner user id (uid). No effect on Windows. Default: false.
 
bool preserve_group_id
 Preserve file owner group id (gid). No effect on Windows. Default: false.
 
bool skip_special_files
 Skipe special files. Default: false.
 
bool remove_empty_directories
 Remove source empty directories after transferring. Default: false.
 
bool remove_after_transfer
 Remove source files after transferring. Default: false.
 
overwrite_e overwrite
 Policy to overwrite files that already exist at the destination. Default: Different.
 
manifest_e file_manifest
 Generate a manifest file to log the transfer. Default: None.
 
char const * file_manifest_directory
 Directory where the manifest should be written too.
 
unsigned long retry_timeout_s
 Remove source files after transferring. Default: 0 - no retry.
 
std::list< char const * > exclude_patterns
 
symlink_policy_e symlink_policy
 How symbolic links are treated. No effect on Windows. Default: SYMLINK_P_FOLLOW.
 
char const * source_base
 
char const * destination_root
 The destination root for the transfer.
 

Detailed Description

A structure of transfer parameters.

Member Data Documentation

bool auto_bwidth_discovery

Automatically detect bandwidth capacity. Default: false Deprecated feature. Measured bandwidth known to be not accurate for connections over 10Mbps.

content_protect_e content_protection

Encryption at rest. Default: CPROTECT_NONE Deprecated feature. If supplied will be ignored

Deprecated:
std::list<char const *> exclude_patterns

List of patterns (maximum 16) used to exclude files from transferring. Two special symbols are accepted as part of a pattern: * to match any character zero or more times, and ? to match any character exactly once.

bool persist

Make a transfer job persistent. Such a job stays active and accepts more transfer sources using AddSourcePath and terminates only when StopJob is invoked.

char const* source_base

Specify the prefix to be stripped off from each source object. The remaining portion of the source path is kept intact at the destination.


Copyright © 2005 - 2008 Aspera, Inc. | asperasoft.com