YGGverse/aquatic
1
0
Fork 0
mirror of https://github.com/YGGverse/aquatic.git synced 2026-03-31 09:45:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve network address config documentation, update TODO

Browse source
This commit is contained in:
Joakim Frostegård 2025-01-13 22:14:15 +01:00
parent ec86d4d652
commit 0eb66f150c
4 changed files with 27 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

3
TODO.md
View file

@ -2,6 +2,9 @@
## High priority ## High priority
* Change network address handling to accept separate IPv4 and IPv6
addresses. Open a socket for each one, setting ipv6_only flag on
the IPv6 one (unless user opts out).
* update zerocopy version (will likely require minor rewrite) * update zerocopy version (will likely require minor rewrite)
* udp (uring) * udp (uring)

20
crates/http/src/config.rs
View file

@ -78,18 +78,14 @@ pub struct NetworkConfig {
/// - "127.0.0.1:3000" binds to port 3000 on the loopback interface /// - "127.0.0.1:3000" binds to port 3000 on the loopback interface
/// (localhost) /// (localhost)
/// ///
/// When it comes to IPv6-style addresses, behaviour differs between /// When it comes to IPv6-style addresses, behaviour is more complex and
/// operating systems. On Linux or macOS, by default, both IPv4 and IPv6 /// differs between operating systems. On Linux, to accept both IPv4 and
/// traffic is received. For instance: /// IPv6 traffic on any interface, use "[::]:3000". Set the "only_ipv6"
/// - "[::]:3000" binds on all interfaces on port 3000, with both IPv4 and /// flag below to limit traffic to IPv6. To bind to the loopback interface
/// IPv6 traffic being accepted /// and only accept IPv6 packets, use "[::1]:3000" and set the only_ipv6
/// - "[::1]:3000" binds on the loopback interface (localhost) on port /// flag. Receiving both IPv4 and IPv6 traffic on loopback is currently
/// 3000, with both IPv4 and IPv6 traffic being accepted /// not supported. For other operating systems, please refer to their
/// /// respective documentation.
/// In this case, to only accept traffic over IPv6, use an IPv6-style
/// address, and additionally set "only_ipv6" below.
///
/// For other operating systems, please refer to their documentation.
pub address: SocketAddr, pub address: SocketAddr,
/// Only allow access over IPv6 /// Only allow access over IPv6
pub only_ipv6: bool, pub only_ipv6: bool,

20
crates/udp/src/config.rs
View file

@ -62,18 +62,14 @@ pub struct NetworkConfig {
/// - "127.0.0.1:3000" binds to port 3000 on the loopback interface /// - "127.0.0.1:3000" binds to port 3000 on the loopback interface
/// (localhost) /// (localhost)
/// ///
/// When it comes to IPv6-style addresses, behaviour differs between /// When it comes to IPv6-style addresses, behaviour is more complex and
/// operating systems. On Linux or macOS, by default, both IPv4 and IPv6 /// differs between operating systems. On Linux, to accept both IPv4 and
/// traffic is received. For instance: /// IPv6 traffic on any interface, use "[::]:3000". Set the "only_ipv6"
/// - "[::]:3000" binds on all interfaces on port 3000, with both IPv4 and /// flag below to limit traffic to IPv6. To bind to the loopback interface
/// IPv6 traffic being accepted /// and only accept IPv6 packets, use "[::1]:3000" and set the only_ipv6
/// - "[::1]:3000" binds on the loopback interface (localhost) on port /// flag. Receiving both IPv4 and IPv6 traffic on loopback is currently
/// 3000, with both IPv4 and IPv6 traffic being accepted /// not supported. For other operating systems, please refer to their
/// /// respective documentation.
/// In this case, to only accept traffic over IPv6, use an IPv6-style
/// address, and additionally set "only_ipv6" below.
///
/// For other operating systems, please refer to their documentation.
pub address: SocketAddr, pub address: SocketAddr,
/// Only allow access over IPv6 /// Only allow access over IPv6
pub only_ipv6: bool, pub only_ipv6: bool,

20
crates/ws/src/config.rs
View file

@ -82,18 +82,14 @@ pub struct NetworkConfig {
/// - "127.0.0.1:3000" binds to port 3000 on the loopback interface /// - "127.0.0.1:3000" binds to port 3000 on the loopback interface
/// (localhost) /// (localhost)
/// ///
/// When it comes to IPv6-style addresses, behaviour differs between /// When it comes to IPv6-style addresses, behaviour is more complex and
/// operating systems. On Linux or macOS, by default, both IPv4 and IPv6 /// differs between operating systems. On Linux, to accept both IPv4 and
/// traffic is received. For instance: /// IPv6 traffic on any interface, use "[::]:3000". Set the "only_ipv6"
/// - "[::]:3000" binds on all interfaces on port 3000, with both IPv4 and /// flag below to limit traffic to IPv6. To bind to the loopback interface
/// IPv6 traffic being accepted /// and only accept IPv6 packets, use "[::1]:3000" and set the only_ipv6
/// - "[::1]:3000" binds on the loopback interface (localhost) on port /// flag. Receiving both IPv4 and IPv6 traffic on loopback is currently
/// 3000, with both IPv4 and IPv6 traffic being accepted /// not supported. For other operating systems, please refer to their
/// /// respective documentation.
/// In this case, to only accept traffic over IPv6, use an IPv6-style
/// address, and additionally set "only_ipv6" below.
///
/// For other operating systems, please refer to their documentation.
pub address: SocketAddr, pub address: SocketAddr,
/// Only allow access over IPv6 /// Only allow access over IPv6
pub only_ipv6: bool, pub only_ipv6: bool,