Index

Symbols

--api-control-port arg (=8886) jetstream-api command line option --authToken arg jetstream-api command line option --authTokenSession arg jetstream-api command line option --host arg (=localhost) jetstream-api command line option

--no-auth jetstream-api command line option --superuser jetstream-api command line option --user arg jetstream-api command line option

_

_event Event Log Structure

_timestamp Event Log Structure

A

activeTransferCount Source Structure addAuthorizedClientAsync() (jetstream.recvinterface.RecvInterface method) address Discover Packet Structure allowOnlyAuthorizedClientsAsync() (jetstream.recvinterface.RecvInterface method) allowRemoteControl Server Information Structure api() (jetstream.api.JetStream method) api_listen() (jetstream.api.JetStream method) API_VERSION (in module jetstream.constants) api_version (jetstream.apiinterface.APIInterface attribute) APIConnectionUnavailableError, [1] apiControlPort Server Information Structure APIInterface (class in jetstream.apiinterface)

APIMethodDeprecatedError, [1] APIMethodNotFoundError, [1] apiVersion Server Information Structure ApiVersionError, [1] auth() (jetstream.serverinterface.ServerInterface method) authAsync() (jetstream.serverinterface.ServerInterface method) authed Server User Structure authRequired, [1] Receiver Server Information Structure Server Information Structure authToken() (jetstream.serverinterface.ServerInterface method) aveRecvRate Source Structure aveRecvRateWindow Source Structure

B

bandwidthLimits Server Information Structure blocksAcked Transfer Structure blockSize Transfer Structure blocksRetransmitted Transfer Structure blocksSent Transfer Structure

borrowIncoming Server Configuration Structure borrowOutgoing Server Configuration Structure BUILD_VERSION (in module jetstream.constants) bytesRecv Transfer Structure bytesSent Transfer Structure

C

certificateValidation Server Information Structure checkpointFrequencySeconds, [1] Destination Transfer Defaults Structure Transfer Structure CommandError, [1] complete Manifest Structure status Receive Transfer Structure status Transfer Structure status completeTransferCount Source Structure configuration Server Information Structure connect() (jetstream.apiinterface.APIInterface method) connected Connection Structure encryptedConnectionState Destination Structure encryptedConnectionState Source Structure encryptedConnectionState Connection Structure connectionId destinationIP destinationPort destinationPublicKey encryptedConnectionState encryptedConnectionState connected encryptedConnectionState disconnected encryptedConnectionState negotiating encryptionEnabled lastDestinationServerId lastDestinationServerUid lastError lastErrorMessage lastRecvTime lastSendTime numTransfersQueued rateControlMethod rateControllerActive relayIP relayPort roundTripTimeMs sendRate sendRateAverage sendRateAverageWindow sendRateMax sendRateMin senderIP senderPort snapshotTime

connectionId, [1] Connection Structure Destination Structure ConnectionNotFoundError, [1] createDestination() (jetstream.sendinterface.SendInterface method) createManifest() (jetstream.sendinterface.SendInterface method) createSharedToken() (jetstream.sendinterface.SendInterface method) createTransfer() (jetstream.sendinterface.SendInterface method) creationTime Shared Token Structure

D

DEFAULT_API_PORT (in module jetstream.constants) DEFAULT_SERVER_ADDRESS (in module jetstream.constants) DEFAULT_TIMEOUT_SECONDS (in module jetstream.constants) deleteDestination() (jetstream.sendinterface.SendInterface method) deleteManifest() (jetstream.sendinterface.SendInterface method) deleteObjectUserData() (jetstream.sendinterface.SendInterface method) deleteSandboxMapping() (jetstream.serverinterface.ServerInterface method) deleteSharedToken() (jetstream.sendinterface.SendInterface method) deleteTransfer() (jetstream.sendinterface.SendInterface method) description Shared Token Structure Destination Structure connectionId destinationAddress destinationIP destinationId destinationPort destinationPublicKey encryptedConnectionState encryptedConnectionState connected encryptedConnectionState disconnected encryptedConnectionState negotiating encryptionEnabled lastDestinationServerId lastDestinationServerUid lastError lastErrorMessage lastRecvTime lastSendTime numTransfersQueued owner permittedDestinationPublicKey priorityLanes relayIP relayPort roundTripTimeMs sendRateAverage sendRateMax senderIP senderPort snapshotTime socketRecvBufferSize, [1] socketSendBufferSize, [1] transferDefaults userData, [1], [2], [3]

Destination Transfer Defaults Structure checkpointFrequencySeconds overwriteMode priority priorityLane sendRateMax transferFlags destinationAddress Destination Structure destinationId, [1] Destination Structure Transfer Structure destinationIP, [1] Connection Structure Destination Structure DestinationNotFoundError, [1] destinationPath, [1] Receive Transfer Structure Transfer Structure destinationPort, [1] Connection Structure Destination Structure destinationPublicKey, [1], [2] Connection Structure Destination Structure Source Structure destPath File Mapping Structure disconnect() (jetstream.apiinterface.APIInterface method) disconnected Connection Structure encryptedConnectionState Destination Structure encryptedConnectionState Source Structure encryptedConnectionState Discover Packet Structure address port discoverId Request Structure downloadCount Shared Token Structure downloadLimit Shared Token Structure duAsync() (jetstream.serverinterface.ServerInterface method)

E

echo() (jetstream.serverinterface.ServerInterface method) encryptedConnectionState, [1], [2] Connection Structure Destination Structure Source Structure connected, Connection Structure connected, Destination Structure connected, Source Structure disconnected, Connection Structure disconnected, Destination Structure disconnected, Source Structure negotiating, Connection Structure negotiating, Destination Structure negotiating, Source Structure encryptionAvailable Server Information Structure encryptionEnabled, [1], [2], [3] Connection Structure Destination Structure Receiver Server Information Structure Source Structure endTime Transfer Structure

environment variable JETSTREAM_API_PASSWORD, [1] JETSTREAM_TRANSFER_PASSWORD, [1] error Manifest Structure status Receive Transfer Structure status Transfer Structure status errorMessage, [1] Manifest Structure Transfer Structure errorTransferCount Source Structure Event Log Structure _event _timestamp eventLogAvailable Server Information Structure expiry Server License Structure expiryTime Shared Token Structure

F

failTransfer() (jetstream.sendinterface.SendInterface method) File Cache Structure highWatermark maximumSize File Mapping Structure destPath fileSize isEmptyDir srcPath

fileCache Server Configuration Structure fileMappings Manifest Files Structure fileSize File Mapping Structure FileSystemError, [1] FileSystemOperationNotSupportedError, [1] FILETYPE_DIRECTORY (in module jetstream.constants) FILETYPE_REGULAR_FILE (in module jetstream.constants)

G

Garbage Collect Structure intervalSeconds timeLimitSeconds Garbage Collection Structure intervalSeconds timeLimitSeconds garbageCollect Server Configuration Structure garbageCollect() (jetstream.serverinterface.ServerInterface method) get_cipher() (jetstream.apiinterface.APIInterface method) get_listen_socket() (jetstream.apiinterface.APIInterface method) get_server_certificate() (jetstream.apiinterface.APIInterface method) get_server_certificate_info() (jetstream.apiinterface.APIInterface method) getConnection() (jetstream.sendinterface.SendInterface method) getConnections() (jetstream.sendinterface.SendInterface method) getDestination() (jetstream.sendinterface.SendInterface method) getDestinations() (jetstream.sendinterface.SendInterface method) getEventLog() (jetstream.serverinterface.ServerInterface method) getFileMappings() (jetstream.helper.Helper static method)

getFilteredManifestFiles() (jetstream.helper.Helper method) getManifest() (jetstream.sendinterface.SendInterface method) getManifestFiles() (jetstream.sendinterface.SendInterface method) getManifests() (jetstream.sendinterface.SendInterface method) getProgress() (jetstream.helper.TransferObject method) getRawStats() (jetstream.helper.TransferObject method) getRequestResult() (jetstream.serverinterface.ServerInterface method) getRequestStatus() (jetstream.serverinterface.ServerInterface method) getSandboxMappings() (jetstream.serverinterface.ServerInterface method) getServerInfo() (jetstream.serverinterface.ServerInterface method) getSharedToken() (jetstream.sendinterface.SendInterface method) getSharedTokens() (jetstream.sendinterface.SendInterface method) getSourcesAsync() (jetstream.recvinterface.RecvInterface method) getStatus() (jetstream.helper.TransferObject method) getThirdPartyLicenses() (jetstream.serverinterface.ServerInterface method) getTransfer() (jetstream.sendinterface.SendInterface method) getTransferFlags() (jetstream.helper.Helper static method) getTransfers() (jetstream.sendinterface.SendInterface method) getTransfersAsync() (jetstream.recvinterface.RecvInterface method)

H

Helper (class in jetstream.helper) highWatermark File Cache Structure

hostName Server Information Structure

I

inactiveTransferCount Source Structure incomingLimitActive Server Configuration Structure incomingMaxConnections Server Configuration Structure incomingRateLimit Server Configuration Structure InsufficientPermissionsError, [1] intervalSeconds, [1] Garbage Collect Structure Garbage Collection Structure

InvalidCredentialsError, [1] InvalidLicenseError, [1] InvalidParameterError, [1] InvalidParameterFormatError, [1] is_connected() (jetstream.apiinterface.APIInterface method) is_secured() (jetstream.apiinterface.APIInterface method) isEmptyDir File Mapping Structure

J

JetStream (class in jetstream.api) jetstream-api command line option --api-control-port arg (=8886) --authToken arg --authTokenSession arg --host arg (=localhost) --no-auth --superuser --user arg

jetstream.constants (module) jetstream.errors (module) jetstream.helper (module) JETSTREAM_API_PASSWORD JETSTREAM_TRANSFER_PASSWORD JetStreamClientException, [1] JetstreamClientException (in module jetstream.errors), [1]

L

lastDestinationServerId, [1] Connection Structure Destination Structure lastDestinationServerUid, [1] Connection Structure Destination Structure lastError, [1] Connection Structure Destination Structure lastErrorMessage, [1] Connection Structure Destination Structure lastErrorTime Receive Transfer Structure

lastRecvTime, [1], [2] Connection Structure Destination Structure Receive Transfer Structure lastSendTime, [1], [2] Connection Structure Destination Structure Receive Transfer Structure license Server Information Structure listen() (jetstream.apiinterface.APIInterface method) lsAsync() (jetstream.serverinterface.ServerInterface method) lsRootsAsync() (jetstream.serverinterface.ServerInterface method)

M

Manifest Files Structure fileMappings manifestId Manifest Structure errorMessage manifestId owner processing status status complete status error status pending totalFiles totalSize

manifestId, [1], [2], [3] Manifest Files Structure Manifest Structure Shared Token Structure Transfer Structure ManifestNotFoundError, [1] maximumSize File Cache Structure mkdirAsync() (jetstream.serverinterface.ServerInterface method) multiplexAvailable Server Information Structure mvAsync() (jetstream.serverinterface.ServerInterface method)

N

negotiating Connection Structure encryptedConnectionState Destination Structure encryptedConnectionState Source Structure encryptedConnectionState

NotAuthenticatedError, [1] NotConnectedError, [1] numTransfersQueued, [1] Connection Structure Destination Structure

O

onlyAuthorizedClientsAllowed Receiver Server Information Structure OperationFailedError, [1] outgoingLimitActive Server Configuration Structure outgoingRateLimit Server Configuration Structure OVERWRITE_IN_PLACE_ALWAYS (in module jetstream.constants) OVERWRITE_IN_PLACE_NEVER (in module jetstream.constants) OVERWRITE_IN_PLACE_SAME_SIZE (in module jetstream.constants)

OVERWRITE_WITH_PARTFILE_ALWAYS (in module jetstream.constants) OVERWRITE_WITH_PARTFILE_BACKUP (in module jetstream.constants) OVERWRITE_WITH_PARTFILE_NEVER (in module jetstream.constants) overwriteMode Destination Transfer Defaults Structure owner, [1], [2], [3] Destination Structure Manifest Structure Shared Token Structure Transfer Structure

P

packetsRecv Transfer Structure packetsSent Transfer Structure PacketTooBigError, [1] passwordRequired Shared Token Structure pending Manifest Structure status Transfer Structure status permittedDestinationPublicKey Destination Structure persistentStateDir Server Configuration Structure port Discover Packet Structure

priority, [1] Destination Transfer Defaults Structure Transfer Structure priorityLane, [1] Destination Transfer Defaults Structure Transfer Structure priorityLanes Destination Structure processing, [1] Manifest Structure Transfer Structure ProtocolError, [1] publicKey Server Information Structure

Q

queueTime Transfer Structure

R

rateControllerActive Connection Structure rateControlMethod Connection Structure Receive Transfer Structure destinationPath lastErrorTime lastRecvTime lastSendTime sourceIP sourcePort status status complete status error status receiving totalSize transferId receiver Server Information Structure Receiver Server Information Structure authRequired encryptionEnabled onlyAuthorizedClientsAllowed receiverIP receiverPort relayIP relayPort socketRecvBufferSize socketSendBufferSize receiverIP Receiver Server Information Structure receiverPort Receiver Server Information Structure

receiving Receive Transfer Structure status recvDiscoverPacketAsync() (jetstream.serverinterface.ServerInterface method) RecvInterface (class in jetstream.recvinterface) relayIP, [1], [2] Connection Structure Destination Structure Receiver Server Information Structure relayPort, [1], [2] Connection Structure Destination Structure Receiver Server Information Structure removeAuthorizedClientAsync() (jetstream.recvinterface.RecvInterface method) Request Structure discoverId requestId RequestId requestId Request Structure RequestNotFoundError, [1] requestTime Transfer Structure ResourceUnavailableError, [1] resumeTransferAsync() (jetstream.sendinterface.SendInterface method) resuming Transfer Structure status revision Server Information Structure rmAsync() (jetstream.serverinterface.ServerInterface method) roundTripTimeMs, [1] Connection Structure Destination Structure

S

sandboxed Server User Structure schedulePingAsync() (jetstream.sendinterface.SendInterface method) secure_socket() (jetstream.apiinterface.APIInterface method) send_command() (jetstream.apiinterface.APIInterface method) sendDiscoverPacketAsync() (jetstream.serverinterface.ServerInterface method) senderIP, [1] Connection Structure Destination Structure senderPort, [1] Connection Structure Destination Structure sendFiles() (jetstream.helper.Helper method) sending Transfer Structure status SendInterface (class in jetstream.sendinterface) sendRate Connection Structure sendRateAverage, [1] Connection Structure Destination Structure sendRateAverageWindow Connection Structure sendRateMax, [1], [2], [3] Connection Structure Destination Structure Destination Transfer Defaults Structure Transfer Structure sendRateMin Connection Structure Server Bandwidth Limits Structure Server Configuration Structure borrowIncoming borrowOutgoing fileCache garbageCollect incomingLimitActive incomingMaxConnections incomingRateLimit outgoingLimitActive outgoingRateLimit persistentStateDir triggersAvailable Server Information Structure allowRemoteControl apiControlPort apiVersion authRequired bandwidthLimits certificateValidation configuration encryptionAvailable eventLogAvailable hostName license multiplexAvailable publicKey receiver revision serverExternalAddress serverId serverName serverTime serverUid sharedTokensAvailable user version Server License Structure expiry valid Server User Structure authed sandboxed superuser token tokenSession userName serverAddress (jetstream.apiinterface.APIInterface attribute) serverExternalAddress Server Information Structure serverId Server Information Structure ServerInterface (class in jetstream.serverinterface) serverName Server Information Structure

serverPort (jetstream.apiinterface.APIInterface attribute) serverTime Server Information Structure serverUid Server Information Structure setPriorityLanesAsync() (jetstream.sendinterface.SendInterface method) setSandboxMapping() (jetstream.serverinterface.ServerInterface method) setSendRateMaxAsync() (jetstream.sendinterface.SendInterface method) setTransferPriorityAsync() (jetstream.sendinterface.SendInterface method) setTransferSendRateMaxAsync() (jetstream.sendinterface.SendInterface method) Shared Token Structure creationTime description downloadCount downloadLimit expiryTime manifestId owner passwordRequired token SharedTokenNotFoundError, [1] sharedTokensAvailable Server Information Structure sleep() (jetstream.serverinterface.ServerInterface method) snapshotTime, [1], [2] Connection Structure Destination Structure Transfer Structure socketRecvBufferSize, [1], [2] Destination Structure, [1] Receiver Server Information Structure socketSendBufferSize, [1], [2] Destination Structure, [1] Receiver Server Information Structure Source Structure activeTransferCount aveRecvRate aveRecvRateWindow completeTransferCount destinationPublicKey encryptedConnectionState encryptedConnectionState connected encryptedConnectionState disconnected encryptedConnectionState negotiating encryptionEnabled errorTransferCount inactiveTransferCount sourceIP sourcePort sourceIP, [1] Receive Transfer Structure Source Structure sourcePort, [1] Receive Transfer Structure Source Structure srcPath File Mapping Structure startTime Transfer Structure status, [1], [2] Manifest Structure Receive Transfer Structure Transfer Structure complete, Manifest Structure complete, Receive Transfer Structure complete, Transfer Structure error, Manifest Structure error, Receive Transfer Structure error, Transfer Structure pending, Manifest Structure pending, Transfer Structure receiving, Receive Transfer Structure resuming, Transfer Structure sending, Transfer Structure suspended, Transfer Structure superuser Server User Structure superuser() (jetstream.serverinterface.ServerInterface method) suspended Transfer Structure status suspendTransferAsync() (jetstream.sendinterface.SendInterface method) SYMLINKS_COPY_CONTENTS (in module jetstream.constants) SYMLINKS_IGNORE (in module jetstream.constants)

T

terminate() (jetstream.serverinterface.ServerInterface method) timeLimitSeconds, [1] Garbage Collect Structure Garbage Collection Structure timeoutSeconds (jetstream.apiinterface.APIInterface attribute) Timestamps token, [1] Server User Structure Shared Token Structure tokenSession Server User Structure totalBlocks Transfer Structure totalBytes Transfer Structure totalFiles Manifest Structure totalSize, [1] Manifest Structure Receive Transfer Structure Transfer Structure blockSize blocksAcked blocksRetransmitted blocksSent bytesRecv bytesSent checkpointFrequencySeconds destinationId destinationPath endTime errorMessage manifestId owner packetsRecv packetsSent priority priorityLane processing queueTime requestTime sendRateMax snapshotTime startTime status status complete status error status pending status resuming status sending status suspended totalBlocks totalBytes transferDataSendRate transferFileReadRate transferId transferNetSendRate transferSendRate transferThroughputRate

TRANSFER_FLAG_NONE (in module jetstream.constants) TRANSFER_FLAG_READ (in module jetstream.constants) TRANSFER_FLAG_READ_WRITE (in module jetstream.constants) TRANSFER_FLAG_WRITE (in module jetstream.constants) transferDataSendRate Transfer Structure transferDefaults Destination Structure transferFileReadRate Transfer Structure transferFlags Destination Transfer Defaults Structure transferId, [1] Receive Transfer Structure Transfer Structure transferNetSendRate Transfer Structure TransferNotFoundError, [1] TransferObject (class in jetstream.helper) transferSendRate Transfer Structure transferThroughputRate Transfer Structure triggersAvailable Server Configuration Structure

U

Unix Time UnsupportedSSLVersionError, [1] updateBandwidthLimits() (jetstream.serverinterface.ServerInterface method) updateConnectionParamsAsync() (jetstream.sendinterface.SendInterface method) updateGarbageCollectSettings() (jetstream.serverinterface.ServerInterface method) updateObjectUserData() (jetstream.sendinterface.SendInterface method)

updateTransferDefaults() (jetstream.sendinterface.SendInterface method) user Server Information Structure userData, [1], [2], [3] Destination Structure, [1], [2], [3] userName Server User Structure

V

valid Server License Structure

version Server Information Structure

W

waitForManifest() (jetstream.sendinterface.SendInterface method)

waitForTransfer() (jetstream.sendinterface.SendInterface method)