Getting Started
API
JetStream
JetStream.api()
JetStream.api_listen()
APIInterface
APIInterface.api_version
APIInterface.serverAddress
APIInterface.serverPort
APIInterface.timeoutSeconds
APIInterface.connect()
APIInterface.disconnect()
APIInterface.get_cipher()
APIInterface.get_listen_socket()
APIInterface.get_server_certificate()
APIInterface.get_server_certificate_info()
APIInterface.is_connected()
APIInterface.is_secured()
APIInterface.listen()
APIInterface.secure_socket()
APIInterface.send_command()
RecvInterface
RecvInterface.addAuthorizedClientAsync()
RecvInterface.allowOnlyAuthorizedClientsAsync()
RecvInterface.getSourcesAsync()
RecvInterface.getTransfersAsync()
RecvInterface.removeAuthorizedClientAsync()
SendInterface
SendInterface.createDestination()
SendInterface.createManifest()
SendInterface.createSharedToken()
SendInterface.createTransfer()
SendInterface.deleteDestination()
SendInterface.deleteManifest()
SendInterface.deleteObjectUserData()
SendInterface.deleteSharedToken()
SendInterface.deleteTransfer()
SendInterface.failTransfer()
SendInterface.getConnection()
SendInterface.getConnections()
SendInterface.getDestination()
SendInterface.getDestinations()
SendInterface.getManifest()
SendInterface.getManifestFiles()
SendInterface.getManifests()
SendInterface.getSharedToken()
SendInterface.getSharedTokens()
SendInterface.getTransfer()
SendInterface.getTransfers()
SendInterface.resumeTransferAsync()
SendInterface.schedulePingAsync()
SendInterface.setPriorityLanesAsync()
SendInterface.setSendRateMaxAsync()
SendInterface.setTransferPriorityAsync()
SendInterface.setTransferSendRateMaxAsync()
SendInterface.suspendTransferAsync()
SendInterface.updateConnectionParamsAsync()
SendInterface.updateObjectUserData()
SendInterface.updateSharedToken()
SendInterface.updateTransferDefaults()
SendInterface.waitForManifest()
SendInterface.waitForTransfer()
ServerInterface
ServerInterface.addWranglerAsync()
ServerInterface.auth()
ServerInterface.authAsync()
ServerInterface.authToken()
ServerInterface.createAPIToken()
ServerInterface.deleteAPIToken()
ServerInterface.deleteSandboxMapping()
ServerInterface.deleteWrangler()
ServerInterface.duAsync()
ServerInterface.echo()
ServerInterface.garbageCollect()
ServerInterface.getAPIToken()
ServerInterface.getAPITokens()
ServerInterface.getEventLog()
ServerInterface.getRequestResult()
ServerInterface.getRequestStatus()
ServerInterface.getSandboxMappings()
ServerInterface.getServerInfo()
ServerInterface.getThirdPartyLicenses()
ServerInterface.getWranglers()
ServerInterface.lsAsync()
ServerInterface.lsListAsync()
ServerInterface.lsRootsAsync()
ServerInterface.mkFileAsync()
ServerInterface.mkdirAsync()
ServerInterface.mvAsync()
ServerInterface.recvDiscoverPacketAsync()
ServerInterface.rmAsync()
ServerInterface.sendDiscoverPacketAsync()
ServerInterface.setExternalAddress()
ServerInterface.setLicenseKeyAsync()
ServerInterface.setSandboxMapping()
ServerInterface.sleep()
ServerInterface.superuser()
ServerInterface.terminate()
ServerInterface.updateAPIToken()
ServerInterface.updateBandwidthLimits()
ServerInterface.updateGarbageCollectSettings()
ServerInterface.wrangler()
Helper
TransferObject
API_VERSION
BUILD_VERSION
DEFAULT_API_PORT
DEFAULT_SERVER_ADDRESS
DEFAULT_TIMEOUT_SECONDS
FILETYPE_DIRECTORY
FILETYPE_REGULAR_FILE
MIN_CIPHER_ENCRYPTED_128
MIN_CIPHER_ENCRYPTED_256
MIN_CIPHER_NONE
MIN_CIPHER_UNENCRYPTED
OVERWRITE_ALWAYS
OVERWRITE_IN_PLACE_SAME_SIZE
OVERWRITE_NEVER
OVERWRITE_VERSIONED
PERMISSIONS
SYMLINKS_COPY_CONTENTS
SYMLINKS_IGNORE
TRANSFER_FLAG_NONE
TRANSFER_FLAG_READ
TRANSFER_FLAG_READ_WRITE
TRANSFER_FLAG_WRITE
TRANSFER_FLAG_WRITE_MTIME
TRANSFER_FLAG_WRITE_ONLY_NEWER
APIConnectionUnavailableError
APIMethodDeprecatedError
APIMethodNotFoundError
ApiVersionError
CommandError
ConnectionNotFoundError
DestinationNotFoundError
FileSystemError
FileSystemOperationNotSupportedError
InsufficientPermissionsError
InvalidCredentialsError
InvalidLicenseError
InvalidParameterError
InvalidParameterFormatError
JetStreamClientException
JetstreamClientException
ManifestNotFoundError
NotAuthenticatedError
NotConnectedError
OperationFailedError
PacketTooBigError
ProtocolError
RequestNotFoundError
ResourceUnavailableError
SharedTokenNotFoundError
TransferNotFoundError
UnsupportedSSLVersionError
Reference
A Discover Packet structure is returned as a result of recvDiscoverPacketAsync().
recvDiscoverPacketAsync()
The IP address on which the discovered server can be reached.
The receive port on which the discovered server can be reached.