lib/computer.iroh/Connection

Connection

open class Connection : Disposable, AutoCloseable, ConnectionInterface

An active QUIC connection to a remote endpoint.

Functions

acceptBi

open suspend override fun acceptBi(): BiStream

Accept the next incoming bidirectional stream.

acceptUni

open suspend override fun acceptUni(): RecvStream

Accept the next incoming unidirectional stream.

alpn

open override fun alpn(): ByteArray

The ALPN protocol negotiated for this connection.

@Synchronized

open override fun close()

open override fun close(errorCode: Long, reason: ByteArray)

Close the connection immediately with the given application error code.

closed

open suspend override fun closed(): String

Wait for the connection to be closed, returning the cause.

closeReason

open override fun closeReason(): String?

If the connection is closed, the reason why. None if still open.

datagramSendBufferSpace

open override fun datagramSendBufferSpace(): ULong

Bytes available in the datagram send buffer.

destroy

open override fun destroy()

maxDatagramSize

open override fun maxDatagramSize(): ULong?

Maximum size of a datagram that can currently be sent.

openBi

open suspend override fun openBi(): BiStream

Open a new bidirectional outgoing stream.

openUni

open suspend override fun openUni(): SendStream

Open a new unidirectional outgoing stream.

paths

open override fun paths(): List<PathSnapshot>

A snapshot of all currently open network paths for this connection.

readDatagram

open suspend override fun readDatagram(): ByteArray

Read the next datagram from the connection.

remoteId

open override fun remoteId(): EndpointId

The `EndpointId` of the remote peer.

rtt

open override fun rtt(): ULong?

Current best estimate of this connection's RTT on the selected path, in milliseconds. None if no path is currently selected.

sendDatagram

open override fun sendDatagram(data: ByteArray)

Send a datagram on this connection.

sendDatagramWait

open suspend override fun sendDatagramWait(data: ByteArray)

Like `Connection::send_datagram` but waits for capacity if the send buffer is full.

setMaxConcurrentBiStreams

open override fun setMaxConcurrentBiStreams(count: ULong)

Set the maximum number of concurrent incoming bidirectional streams.

setMaxConcurrentUniStreams

open override fun setMaxConcurrentUniStreams(count: ULong)

Set the maximum number of concurrent incoming unidirectional streams.

setReceiveWindow

open override fun setReceiveWindow(count: ULong)

Set the receive window for this connection.

side

open override fun side(): Side

Which side of the connection we are (client or server).

stableId

open override fun stableId(): ULong

A stable identifier for this connection.

stats

open override fun stats(): ConnectionStats

A flat snapshot of the most useful headline statistics for this connection.

watchPathEvents

open override fun watchPathEvents(callback: PathEventCallback): WatchHandle

watchPaths

open override fun watchPaths(callback: PathChangeCallback): WatchHandle