Destination Structure¶

A Destination structure is returned from createDestination(), getDestination() and getDestinations().

connectionId¶

A connection ID. Connection IDs are returned from getConnection(), and used to refer to a specific connection.

destinationAddress¶

The address (host name) for a destination.

destinationId¶

A destination ID. Destination IDs are returned from createDestination, and used in other methods to refer to a specific destination.

destinationIP¶

The IP for a destination.

destinationPort¶

The UDP receiver port for a destination.

destinationPublicKey¶

The public key for this destination. This public key must be specified for encrypted transfers to this server.

encryptedConnectionState¶

Describes the state of the encryption negotiation, if using an encrypted connection. May be one of:

disconnected
negotiating
connected

encryptionEnabled¶

True if the server has encryption enabled. If encryption is enabled, transfers can only be initiated to a server which also has encryption enabled.

lastDestinationServerId¶

The server instance ID that most recently acknowledged a transmission to a destination. This value may be None if no communication has yet been established.

lastDestinationServerUid¶

The persistent server ID that most recently acknowledged a transmission to a destination. This value may be None if no communication has yet been established.

lastError¶

The last critical error that occurred when connecting to the remote server. None if there are currently no errors.

lastErrorMessage¶

Error message associated with lastError.

lastRecvTime¶

A timestamp indicating the last receive activity. See Timestamps.

lastSendTime¶

A timestamp indicating the last send activity. See Timestamps.

numTransfersQueued¶

The number of transfers waiting in a destination’s queue.

owner¶

The owner of this destination. A destination is only visible to its owner, or a superuser.

ownerToken¶

The owner of this destination, if this destination was created by a token. A destination is only visible to its token, owner, or a superuser.

ownerTokenSession¶

The token session of this token that created this destination.

permittedDestinationPublicKey¶

The key used to authorize the remote server. If the remote server’s public key doens’t match this key, the connection will not succeed.

priorityLanes¶

A mapping of the priority lanes. Each lane has a name and a proportion of the total sending bandwidth.

relayIP¶

The IP for the relay server, if using a relay. Will be None if not using a relay.

relayPort¶

The port for the relay server, if using a relay. Will be None if not using a relay.

roundTripTimeMs¶

The ‘ping time’ between the sender and receiver in milliseconds.

senderIP¶

The IP for the sender connection.

senderPort¶

The port for the sender connection.

sendRateAverage¶

The average send rate for a transfer, in kilobits-per-second. This rate represents a “slice” of time, per “send rate average window”.

sendRateMax¶

The maximum send rate allowed for this server. The Rate Controller will not allow the send rate to exceed this value.

snapshotTime¶

A timestamp indicating when the information was recorded. JetStream captures a snapshot of its state once per second. See Timestamps.

socketRecvBufferSize¶

The size of the buffer allocated for receiving data.

socketSendBufferSize¶

The size of the buffer allocated for sending data.

transferDefaults¶

Destination Transfer Defaults Structure

userData¶

Key-value map of user attached metadata. Use updateObjectUserData() and deleteObjectUserData() to manipulate object user data.

Changed in version 1.6.1: Added priorityLanes keys.

Changed in version 1.7.0: Added lastError, lastErrorMessage, owner, permittedDestinationPublicKey, and userData keys. Removed encryptionMismatch, rateControlActive, rateControlMethod, sendRate, sendRateMin, sendRateAverageWindow, and versionMismatch keys.

Changed in version 2.4.0: Added ownerToken, ownerTokenSession keys.

Destination Transfer Defaults Structure¶

A Destination Transfer Defaults structure is returned as part of the Destination Structure.

checkpointFrequencySeconds¶: The default value for the checkpointFrequencySeconds parameter of createTransfer().
overwriteMode¶: The default value for the overwriteMode parameter of createTransfer().
priority¶: The default value for the priority parameter of createTransfer().
priorityLane¶: The default value for the priorityLane parameter of createTransfer().
sendRateMax¶: The default value for the sendRateMax parameter of createTransfer().
transferFlags¶: The default value for the transferFlags parameter of createTransfer().

Changed in version 1.6.1: Added sendRateMax, and priorityLane keys.

Changed in version 1.7.0: Added overwriteMode keys.