Description

This PR encapsulates the quinn::TransportConfig in a new struct called QuicTransportConfig. It has all of the same methods as the quinn::TransportConfig, but the follow methods will log warnings if the user given values make iroh + multipath sub-optimal:

• default_path_keep_alive_interval() - should be at most HEARTBEAT_INTERVALms
• default_path_max_idle_timeout() - should be at most PATH_MAX_IDLE_TIMEOUTms
• max_concurrent_multipath_paths() - should be at least MAX_MULTIPATH + 1
• set_max_remote_nat_traversal_addresses() - should be at least MAX_MULTIPATH

These values are also set properly by default when creating a QuicTransportConfig.

quinn encapsulation/co-location

Created a new mod quic and co-located all the quinn exports there.

This would be the mod where we do any future encapsulation.

Note: the StaticConfig struct is a private struct that still uses quinn::TransportConfig directly.

Second note: the ConnectConfig was Clone, and no longer is. This is due to a weird tension in our encapsulation of quinn::TransportConfig. The quinn APIs typically expect an Arc<quinn::TransportConfig>, however if we store an Arc of the quinn::TransportConfig in QuicTransportConfig, then we can't actually mutate any fields inside it, unless we also put it in a Mutex. The "slickest" way to ensure that we did not need to store an Arc<quinn::TransportConfig>, was to ensure that we didn't have APIs that required cloning or Arc-ing the QuicTransportConfig itself (quinn::TransportConfig is also not clone).

It's possible this is terribly annoying for our users, so if someone else has an ergonomic way of handling this, please let me know.

waiting for PR n0-computer/noq#213 to merge, then this can be merged merged

third note: I adjusted the HEARTBEAT_INTERVAL and PATH_MAX_IDLE_TIMEOUT to be numerical values rather than Durations, so they can be read-able in the documentation.

closes #3635

Breaking Changes

• iroh
  • changes
    • QuinnTransportConfig renamed to QuicTransportConfig & is now Clone
    • ConnectOptions::transport_config: Option<Arc<quinn::TransportConfig>> -> `ConnectOptions::transport_config: Option
    • ConnectOptions::with_transport_config(mut self, transport_config: Arc<quinn::TransportConfig>) -> `ConnectOptions::with_transport_config(mut self, transport_config: QuicTransportConfig)

Open Questions

• Need verification that my assumptions about "at least" and "at most" for the above are the correct assumptions about what we want. done in Improve setting TransportConfig parameters #3635