From 00f55788c2228abc2b6961ad1e3ac9627a15c506 Mon Sep 17 00:00:00 2001 From: "sashakoshka@tebibyte.media" Date: Tue, 21 Jan 2025 20:37:10 -0500 Subject: [PATCH] Add note about the dial function --- dial.go | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/dial.go b/dial.go index 18c9dd4..95a24c9 100644 --- a/dial.go +++ b/dial.go @@ -6,7 +6,9 @@ import "crypto/tls" import "github.com/quic-go/quic-go" // Dial opens a connection to a server. The network must be one of "quic", -// "quic4", (IPv4-only) "quic6" (IPv6-only), or "unix". +// "quic4", (IPv4-only) "quic6" (IPv6-only), or "unix". For now, "quic4" and +// "quic6" don't do anything as the quic-go package doesn't seem to support this +// behavior. func Dial(ctx context.Context, network, address string) (Conn, error) { return (Dialer { }).Dial(ctx, network, address) } @@ -17,7 +19,9 @@ type Dialer struct { } // Dial opens a connection to a server. The network must be one of "quic", -// "quic4", (IPv4-only) "quic6" (IPv6-only), or "unix". +// "quic4", (IPv4-only) "quic6" (IPv6-only), or "unix". For now, "quic4" and +// "quic6" don't do anything as the quic-go package doesn't seem to support this +// behavior. func (diale Dialer) Dial(ctx context.Context, network, address string) (Conn, error) { switch network { case "quic", "quic4", "quic6": return diale.dialQUIC(ctx, network, address)