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 ssh_internal1
unsigned int ssh_internal2
union {
   struct {
      unsigned int   field1
      unsigned int   field2
   }   reserved
   struct {
      void *   context
   }   audit
extra
union {
   struct {
      unsigned int   field3
      unsigned int   field4
   }   reserved
   struct {
      char *   name
   }   set
character
unsigned int reserved5
unsigned int reserved6

Detailed Description

SFT parameters.

Each SFT session can be configured with parameters.


Field Documentation

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

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

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

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

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

Flag that specifies whether incremental checksums are used.

unsigned int field1

Reserved for current use.

unsigned int field2

Reserved for current use.

unsigned int field3

Reserved for current use.

unsigned int field4

Reserved for current use.

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".

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

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

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

ASCII transfer newline string.

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.

Length of ASCII transfer newline string.

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.

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

File transfer mode (default = binary).

Maximum number of maximum size SFTP DATA packets queued.

Maximum size of a SFTP DATA packet.

unsigned int reserved5

Reserved for future use.

unsigned int reserved6

Reserved for future use.

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.

Context given to the signal function.

unsigned int ssh_internal1

Reserved for internal use.

unsigned int ssh_internal2

Reserved for internal use.