ASFaspSessionParameters
@interface ASFaspSessionParameters
Encapsulates many of the parameters needed to create a transfer session
-
Create a set of transfer parameters describing an upload with the given host and user
Declaration
Objective-C
+ (nonnull instancetype)uploadSessionWithHost:(id)hst user:(id)usr;
Swift
class func uploadSessionWithHost(hst: AnyObject!, user usr: AnyObject!) -> Self
-
Create a set of transfer parameters describing a download with the given host and user
Declaration
Objective-C
+ (nonnull instancetype)downloadSessionWithHost:(id)hst user:(id)usr;
Swift
class func downloadSessionWithHost(hst: AnyObject!, user usr: AnyObject!) -> Self
-
The transfer direction, one of ASFaspDirectionUpload or ASFaspDirectionDownload
Declaration
Objective-C
@property (assign, readwrite, nonatomic) int direction;
Swift
var direction: Int32 { get set }
-
Remote host to transfer to or from, e.g. example.com or 192.168.0.1
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *host
-
SSH port to use for the transfer. Defaults to 22.
Declaration
Objective-C
@property (assign, readwrite, nonatomic) int sshPort;
Swift
var sshPort: Int32 { get set }
-
UDP port to use for the transfer. Defaults to 33001
Declaration
Objective-C
@property (assign, readwrite, nonatomic) int udpPort;
Swift
var udpPort: Int32 { get set }
-
Destination on the remote server to/from which to transfer
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *destinationPath
-
Username to use for the transfer
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *user
-
Password to use for authentication. Either a password or a private key is necessary
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *password
-
Full path to the private key to use for authentication. Either a private key or a password is necessary
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *privateKeyFilename
-
Passphrase to use in case the private key is passphrase-protected
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *privateKeyPassphrase
-
Token to use for transfer authentication. Tokens are optional and are used in conjunction with username-and-password or username-and-privatekey authentication
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *token
-
Controls whether encryption at rest (EAR) is enabled or disabled. Defaults to false
Declaration
Objective-C
@property (assign, readwrite, nonatomic) int earEnabled;
Swift
var earEnabled: Int32 { get set }
-
The passphrase to use when EAR is enabled
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *earPassphrase
-
Controls the encryption of data over the wire (as opposed to encryption at rest). One of ASCipherNone, ASCipherAES192 or ASCipherAES256. The default is ASCipherAES128
Declaration
Objective-C
@property (assign, readwrite, nonatomic) int encryptionCipher;
Swift
var encryptionCipher: Int32 { get set }
-
The target rate to use for the transfer in bits per second. The ultimate value determining the session’s target rate is the targetRate attribute of an ASFaspSession or ASPeristentFaspSession instance; note that this value may be modified by the server or by calling -[ASAbstractFaspSession setTargetRate:] on the session
Declaration
Objective-C
@property (assign, readwrite, nonatomic) unsigned long long initialTargetRate;
Swift
var initialTargetRate: UInt64 { get set }
-
The transfer rate policy, one of ASRatePolicyFixed, ASRatePolicyFair or ASRacePolicyTrickle. The default is ASRatePolicyFair
Declaration
Objective-C
@property (assign, readwrite, nonatomic) int ratePolicy;
Swift
var ratePolicy: Int32 { get set }
-
A string cookie to pass along to the FASP session
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *cookie
-
A JSON formatted string to pass along to the FASP session as tags
Declaration
Objective-C
@property (nonatomic, strong, nonnull) NSString *tags
-
The session create policy. Valid values are ASCreatePolicyPreserveTime, ASCreatePolicyBackup, ASCreatePolicySkipExisting, ASCreatePolicyDirPath. The default is ASCreatePolicyDirPath
Declaration
Objective-C
@property (assign, readwrite, nonatomic) int createPolicy;
Swift
var createPolicy: Int32 { get set }
-
File resume policy, one of ASResumePolicyNone, ASResumePolicyAttrs, AASResumePolicyFullCsum, ASResumePolicySparseCsum.
Declaration
Objective-C
@property (assign, readwrite, nonatomic) int resumePolicy;
Swift
var resumePolicy: Int32 { get set }
-
File overwrite policy, one of ASOverwritePolicyDiff, ASOverwritePolicyOlder, ASOverwritePolicyNever or ASOverwriteolicyAlways.
Declaration
Objective-C
@property (assign, readwrite, nonatomic) int overwritePolicy;
Swift
var overwritePolicy: Int32 { get set }
-
Whether or not session transfer size is precalculated on the server before the transfer. One of ASPrecalcYes or ASPrecalcNo. The default is ASPrecalcYes
Declaration
Objective-C
@property (assign, readwrite, nonatomic) int precalc;
Swift
var precalc: Int32 { get set }