mirrors/uquic
1
0
Fork 0
mirror of https://github.com/refraction-networking/uquic.git synced 2025-04-06 21:57:36 +03:00
Code Issues Projects Releases Packages Wiki Activity

improve documentation for our new API

Browse source
This commit is contained in:
Lucas Clemente 2017-02-25 11:28:26 +01:00
parent 20b2069d78
commit 1a0dc05211
4 changed files with 39 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

12
client.go
View file

@ -36,7 +36,8 @@ var (
errCloseSessionForNewVersion = errors.New("closing session in order to recreate it with a new version")
)
// Dial establishes a new QUIC connection to a server
// Dial establishes a new QUIC connection to a server using a net.PacketConn.
// The host parameter is used for SNI.
func Dial(pconn net.PacketConn, remoteAddr net.Addr, host string, config *Config) (Session, error) {
connID, err := utils.GenerateConnectionID()
if err != nil {
@ -68,9 +69,10 @@ func Dial(pconn net.PacketConn, remoteAddr net.Addr, host string, config *Config
return c.establishConnection()
}
// DialAddr establishes a new QUIC connection to a server
func DialAddr(hostname string, config *Config) (Session, error) {
udpAddr, err := net.ResolveUDPAddr("udp", hostname)
// DialAddr establishes a new QUIC connection to a server.
// The hostname for SNI is taken from the given address.
func DialAddr(addr string, config *Config) (Session, error) {
udpAddr, err := net.ResolveUDPAddr("udp", addr)
if err != nil {
return nil, err
}
@ -80,7 +82,7 @@ func DialAddr(hostname string, config *Config) (Session, error) {
return nil, err
}
return Dial(udpConn, udpAddr, hostname, config)
return Dial(udpConn, udpAddr, addr, config)
}
func (c *client) establishConnection() (Session, error) {