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 uploadSession(withHost hst: Any!, user usr: Any!) -> 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 downloadSession(withHost hst: Any!, user usr: Any!) -> 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

    Swift

    var host: UnsafeMutablePointer<Int32> { get set }

  • 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

    Swift

    var destinationPath: UnsafeMutablePointer<Int32> { get set }

  • Username to use for the transfer

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *user

    Swift

    var user: UnsafeMutablePointer<Int32> { get set }

  • Password to use for authentication. Either a password or a private key is necessary

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *password

    Swift

    var password: UnsafeMutablePointer<Int32> { get set }

  • 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

    Swift

    var privateKeyFilename: UnsafeMutablePointer<Int32> { get set }

  • Passphrase to use in case the private key is passphrase-protected

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *privateKeyPassphrase

    Swift

    var privateKeyPassphrase: UnsafeMutablePointer<Int32> { get set }

  • 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

    Swift

    var token: UnsafeMutablePointer<Int32> { get set }

  • 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

    Swift

    var earPassphrase: UnsafeMutablePointer<Int32> { get set }

  • 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 }

  • Deprecated, please use initialTargetRateKbps instead. Be sure to switch from bps to kbps

    Declaration

    Objective-C

    @property (readonly, nonatomic) unsigned long long initialTargetRate;

    Swift

    var initialTargetRate: UInt64 { get }

  • Deprecated, pelase use minTargetRateKbps instead. Be sure to switch from bps to kbps

    Declaration

    Objective-C

    @property (readonly, nonatomic) unsigned long long minTargetRate;

    Swift

    var minTargetRate: UInt64 { get }

  • The target rate to use for the transfer in kilo bits per second (1 kbps = 1000 bps). The ultimate value determining the session’s target rate is the targetRateKbps attribute of an ASFaspSession or ASPeristentFaspSession instance; note that this value may be modified by the server or by calling -[ASAbstractFaspSession setTargetRateKbps:] on the session

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
    unsigned long long initialTargetRateKbps;

    Swift

    var initialTargetRateKbps: 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

    Swift

    var cookie: UnsafeMutablePointer<Int32> { get set }

  • A JSON formatted string to pass along to the FASP session as tags

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *tags

    Swift

    var tags: UnsafeMutablePointer<Int32> { get set }

  • 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 }

  • Controls Whether or not HTTP fallback is used. When set to ASHttpFallbackNever HTTP fallback is never used. When set to ASHttpFallbackOnFailure HTTP fallback is used only if the initial FASP transfer failed to connect. When set to ASHttpFallbackAlways HTTP fallback will always be used and no fasp transfer will be atempted - use of ASHttpFallbackAlways is discouraged except for debugging purposes. The default is ASHttpFallbackNever.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) int httpFallback;

    Swift

    var httpFallback: Int32 { get set }

  • HTTPS key file name for use with httpFallback (use of the key file depends on the value of httpCertHostCheck)

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *httpKeyFilename

    Swift

    var httpKeyFilename: UnsafeMutablePointer<Int32> { get set }

  • HTTPS certificate file name for use with httpFallback (use of the certificate file depends on the value of httpCertHostCheck)

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *httpCertFilename

    Swift

    var httpCertFilename: UnsafeMutablePointer<Int32> { get set }

  • Controls whether or not the hostname is verified against the certificate. Only used for HTTPS, i.e. when encryptionCipher is different from ASencryptionCipherNone. Valid values are ASHttpCertHostCheckNo, ASHttpCertHostCheckExact or ASHttpCertHostCheckWildcard. The default is ASHttpCertHostCheckNo.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) int httpCertHostCheck;

    Swift

    var httpCertHostCheck: Int32 { get set }

  • The port to use for HTTP fallback. If left at 0 (the default value) port 80 will be used for HTTP requests and 443 for HTTPS requests.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) int httpFallbackPort;

    Swift

    var httpFallbackPort: Int32 { get set }

  • HTTP proxy address used for HTTP fallback requests. If set to a non-empty string this proxy server will be used for all HTTP fallback requests. Note that the system proxy is ignored: if this address is empty HTTP requests willbe made directly to the remote host, whereas if this address is non-empty HTTP requests will be routed through this proxy.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *httpFallbackProxyAddress

    Swift

    var httpFallbackProxyAddress: UnsafeMutablePointer<Int32> { get set }

  • HTTP proxy port used for HTTP fallback requests. If left at 0 (the default value) port 80 will be used for HTTP requests and 443 for HTTPS requests. Only used if httpFallbackProxyAddress is non-empty

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) int httpFallbackProxyPort;

    Swift

    var httpFallbackProxyPort: Int32 { get set }

  • HTTP proxy username. Only used if httpFallbackProxyAddress and httpFallbackProxyPassword are non empty

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *httpFallbackProxyUsername

    Swift

    var httpFallbackProxyUsername: UnsafeMutablePointer<Int32> { get set }

  • HTTP proxy password. Only used if httpFallbackProxyAddress and httpFallbackProxyUsername are non empty

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *httpFallbackProxyPassword

    Swift

    var httpFallbackProxyPassword: UnsafeMutablePointer<Int32> { get set }