Package: github.com/tmc/go-iroh/internal/netreport

package netreport Import Path github.com/tmc/go-iroh/internal/netreport (on go.dev) Dependency Relation imports 15 packages, and imported by one package

Involved Source Files client.go defaults.go d doc.go Package netreport probes the local network environment to build a [Report] describing relay latencies and (where available) the public reflexive address of the host. It is a port of iroh's net_report module (iroh/src/net_report). A [Client] runs three kinds of probes against the configured relays: - HTTPS probes fetch the relay's "/ping" path and time the round trip. - QAD probes open a QUIC Address Discovery connection (ALPN "/iroh-qad/0", QUIC port 7842) and read the connection RTT. - A captive-portal check fetches "/generate_204" with an X-Iroh-Challenge header and verifies the X-Iroh-Response echo, but only on full reports. From those probes the client picks a preferred relay, applying hysteresis so a responsive relay is not abandoned unless a new one is meaningfully faster. # Reflexive address discovery A QAD connection also learns the host's public address from the relay via the QUIC Address Discovery observed-address extension (draft-seemann-quic-address-discovery), implemented in the forked quic-go [github.com/tmc/go-iroh/internal/qng] (slice X3). The QAD client advertises the receive-only address-discovery role, and a QAD relay reports the client's reflexive address with OBSERVED_ADDRESS frames; the latest report is surfaced as [Report.GlobalV4]/[Report.GlobalV6] (and the matching UDP fields). Reports arrive after the handshake, so [qadConn.observedAddr] waits briefly for the first one; an immediate read would always miss. Without a report (not negotiated, or timed out) the probe stays latency-only. Which socket a probe rides decides what the observed address means: a private per-probe socket learns a mapping that dies with it. [Client.WithQADDialer] routes probes through the caller's transport instead, so the observed address is the caller's real public mapping. probe.go probes.go qad.go report.go

Code Examples package main import ( "context" "fmt" "github.com/tmc/go-iroh/internal/netreport" "github.com/tmc/go-iroh/relay" ) func main() { client := netreport.NewClient(relay.NewMap()) report, err := client.GetReport(context.Background(), netreport.IfStateDetails{HaveV4: true}, true) if err != nil { fmt.Println("error:", err) return } fmt.Println("has udp:", report.HasUDP()) fmt.Println("preferred relay set:", !report.PreferredRelay.IsZero()) } Probe_String package main import ( "fmt" "github.com/tmc/go-iroh/internal/netreport" ) func main() { fmt.Println(netreport.ProbeHTTPS) fmt.Println(netreport.ProbeQADv4) fmt.Println(netreport.ProbeQADv6) }

Package-Level Functions (only one)

func NewClient(relayMap *relay.Map) *Client NewClient returns a Client that probes the relays in relayMap.

Package-Level Variables (only one)

var ErrExtensionNotNegotiated error ErrExtensionNotNegotiated is returned by [qadConn.observedAddr] when no reflexive address is available: either QUIC Address Discovery was not negotiated on the connection, or no OBSERVED_ADDRESS report arrived within [qadObservedAddrWait]. The forked quic-go implements the extension (slice X3); see the package doc.

Package-Level Constants (total 3)

const ProbeHTTPS Probe = 0 ProbeHTTPS times an HTTPS GET of the relay's probe path.

const ProbeQADv4 Probe = 1 ProbeQADv4 times a QUIC Address Discovery connection over IPv4.

const ProbeQADv6 Probe = 2 ProbeQADv6 times a QUIC Address Discovery connection over IPv6.