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.

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.

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.

reverseDial

True if the receiver dialled back to this server to make the connection (reverse dial). False if this server dialled the connection, directly or through 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.

sendRateMax

The maximum send rate allowed for this connection, in kilobits-per-second. The sender does not send faster than this rate.

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.

Changed in version 3.0.0: Removed rateControlMethod and rateControllerActive. The JetStream rate controller was replaced by the QUIC transport’s own congestion control, so neither field is emitted any more. The per-transfer choice is transport (udp or tcp) on the transfer (API 56). It replaced congestionControl.

Changed in version 3.0.0: Removed destinationPublicKey, encryptedConnectionState, encryptionEnabled, sendRate, sendRateAverage, sendRateAverageWindow and sendRateMin. Added reverseDial.