Add note about the dial function
This commit is contained in:
parent
f1d6bf7b1b
commit
00f55788c2
8
dial.go
8
dial.go
@ -6,7 +6,9 @@ import "crypto/tls"
|
|||||||
import "github.com/quic-go/quic-go"
|
import "github.com/quic-go/quic-go"
|
||||||
|
|
||||||
// Dial opens a connection to a server. The network must be one of "quic",
|
// 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) {
|
func Dial(ctx context.Context, network, address string) (Conn, error) {
|
||||||
return (Dialer { }).Dial(ctx, network, address)
|
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",
|
// 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) {
|
func (diale Dialer) Dial(ctx context.Context, network, address string) (Conn, error) {
|
||||||
switch network {
|
switch network {
|
||||||
case "quic", "quic4", "quic6": return diale.dialQUIC(ctx, network, address)
|
case "quic", "quic4", "quic6": return diale.dialQUIC(ctx, network, address)
|
||||||
|
Loading…
Reference in New Issue
Block a user