Your browser does not allow this site to store cookies and other data. Some functionality on this site may not work without them. See Privacy Policy for details on how we would use cookies.

SshSftParamRec Struct Reference

Data Fields

SshSftStreaming filecopy_streaming
SshSftTransferMode filecopy_transfer_mode
char * filecopy_newline
size_t filecopy_newline_len
SshSftBoolean filecopy_newline_force
char * filecopy_ascii_extensions
SshSftBoolean filecopy_force_lower_case
char * filecopy_prefix
SshSftBoolean filecopy_attrs_preserve
SshSftChecksum filecopy_checksum
SshSftBoolean checksum_incremental
int checksum_hash_max_iterations
int checksum_hash_min_block_size
int checksum_hash_max_block_size
SshSftTime checkpoint_update_interval_seconds
SshSftUInt64 checkpoint_update_interval_bytes
int protocol_request_max_size
int protocol_request_max_num
SshSftSignalCB signal_cb
void * signal_cb_ctx
unsigned int reserved1
unsigned int reserved2
unsigned int reserved3
unsigned int reserved4
unsigned int reserved5
unsigned int reserved6
unsigned int reserved7
unsigned int reserved8

Detailed Description

SFT parameters.

Each SFT session can be configured with parameters.

Field Documentation

SshSftUInt64 checkpoint_update_interval_bytes

Checkpoint database update interval in bytes. Default is 10 megabytes.

SshSftTime checkpoint_update_interval_seconds

Checkpoint database update interval in seconds. Default is 10 seconds.

int checksum_hash_max_block_size

The maximum size of the data block that is used in calculating checksums. Default is SSH_SFT_HASH_MAX_BLOCK_SIZE.

int checksum_hash_max_iterations

The number of iteration used for finding the match using binary search. Default is SSH_SFT_HASH_MAX_ITERATIONS.

int checksum_hash_min_block_size

The minimum size of the data block that is used in calculating checksums. Default is SSH_SFT_HASH_MIN_BLOCK_SIZE.

SshSftBoolean checksum_incremental

Flag that specifies whether incremental checksums are used.

char* filecopy_ascii_extensions

ASCII file extensions. A comma separated list of extensions, e.g. "txt,htm*,php*". If transfer mode is AUTO, files that have correct extension are transfered as ASCII files, e.g. "filename.txt".

SshSftBoolean filecopy_attrs_preserve

Flag that specifies, whether source file attributes are preserved in the destination file.

SshSftChecksum filecopy_checksum

Option that specifies what kind of auto resume mechanisms are used: checksums, checkpoint database or none.

SshSftBoolean filecopy_force_lower_case

Flag that specifies, whether lower case file names are forced in the destination.

char* filecopy_newline

ASCII transfer newline string.

SshSftBoolean filecopy_newline_force

Option that specifies whether configured newline is used. If 'filecopy_newline_force' is set, server provided newline is disregarded and configured 'filecopy_newline' is used instead.

size_t filecopy_newline_len

Length of ASCII transfer newline string.

char* filecopy_prefix

Temporary file name prefix. 'filecopy_prefix' is added in front of the destination file name while the file is being copied. After the file has been succesfully copied, prefix is removed from destination file name.

SshSftStreaming filecopy_streaming

Option that specifies, whether streaming is used in file copy.

SshSftTransferMode filecopy_transfer_mode

File transfer mode (default = binary).

int protocol_request_max_num

Maximum number of maximum size SFTP DATA packets queued.

int protocol_request_max_size

Maximum size of a SFTP DATA packet.

unsigned int reserved1

Reserved for future use.

unsigned int reserved2

Reserved for future use.

unsigned int reserved3

Reserved for future use.

unsigned int reserved4

Reserved for future use.

unsigned int reserved5

Reserved for future use.

unsigned int reserved6

Reserved for future use.

unsigned int reserved7

Reserved for future use.

unsigned int reserved8

Reserved for future use.

SshSftSignalCB signal_cb

Pointer to the function that is used for checking whether SUSPEND, RESUME or ABORT signal is received. It is also used for passing on the KILL signal from connection.

void* signal_cb_ctx

Context given to the signal function.