Connection Structure

A Connection structure is returned from getConnection() and getConnections().

connectionId

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

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 receive activity. See Timestamps.

numTransfersQueued

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

rateControllerActive

If True, the JetStream Rate Controller is used to dynamically adjust the transfer rates for optimal performance.

rateControlMethod

Sets the algorithm used by the rate controller.

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.

sendRate

The configured send rate for this server, in kilobits-per-second.

sendRateAverage

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

sendRateAverageWindow

The send rate measured within a “window” of time, in kilobits-per-second. This shows the performance “right now”.

sendRateMax

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

sendRateMin

The minimum send rate allowed for this server. The Rate Controller will maintain the send rate at or above 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.

Changed in version 1.7.0: Added connection structure.