go/src/pkg/net/sock_posix.go

// Copyright 2009 The Go Authors.  All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// +build darwin freebsd linux netbsd openbsd windows

package net

import (
	"syscall"
	"time"
)

// A sockaddr represents a TCP, UDP, IP or Unix network endpoint
// address that can be converted into a syscall.Sockaddr.
type sockaddr interface {
	Addr

	// family returns the platform-dependent address family
	// identifier.
	family() int

	// isWildcard reports whether the address is a wildcard
	// address.
	isWildcard() bool

	// sockaddr returns the address converted into a syscall
	// sockaddr type that implements syscall.Sockaddr
	// interface. It returns a nil interface when the address is
	// nil.
	sockaddr(family int) (syscall.Sockaddr, error)

	// toAddr returns the address represented in sockaddr
	// interface. It returns a nil interface when the address is
	// nil.
	toAddr() sockaddr
}

// Generic POSIX socket creation.
func socket(net string, f, t, p int, ipv6only bool, laddr, raddr sockaddr, deadline time.Time, toAddr func(syscall.Sockaddr) Addr) (fd *netFD, err error) {
	s, err := sysSocket(f, t, p)
	if err != nil {
		return nil, err
	}

	if err = setDefaultSockopts(s, f, t, ipv6only); err != nil {
		closesocket(s)
		return nil, err
	}

	// This function makes a network file descriptor for stream
	// and datagram dialers, stream and datagram listeners.
	//
	// For dialers, they will require either named or unnamed
	// sockets for their flights.  We can assume that it's just a
	// request from a dialer that wants a named socket when both
	// laddr and raddr are not nil.  A dialer will also require a
	// connection setup initiated socket when raddr is not nil.
	//
	// For listeners and some dialers on datagram networks, they
	// will only require named sockets.  So we can assume that
	// it's just for a listener or a datagram dialer when laddr is
	// not nil but raddr is nil.

	var lsa syscall.Sockaddr
	if laddr != nil && raddr == nil {
		// We provide a socket that listens to a wildcard
		// address with reusable UDP port when the given laddr
		// is an appropriate UDP multicast address prefix.
		// This makes it possible for a single UDP listener
		// to join multiple different group addresses, for
		// multiple UDP listeners that listen on the same UDP
		// port to join the same group address.
		if lsa, err = listenerSockaddr(s, f, laddr); err != nil {
			closesocket(s)
			return nil, err
		}
	} else if laddr != nil && raddr != nil {
		if lsa, err = laddr.sockaddr(f); err != nil {
			closesocket(s)
			return nil, err
		}
	}

	if lsa != nil {
		if err = syscall.Bind(s, lsa); err != nil {
			closesocket(s)
			return nil, err
		}
	}

	if fd, err = newFD(s, f, t, net); err != nil {
		closesocket(s)
		return nil, err
	}
	if err := fd.init(); err != nil {
		fd.Close()
		return nil, err
	}

	var rsa syscall.Sockaddr
	if raddr != nil {
		rsa, err = raddr.sockaddr(f)
		if err != nil {
			return nil, err
		}
	}

	if rsa != nil {
		if !deadline.IsZero() {
			setWriteDeadline(fd, deadline)
		}
		if err = fd.connect(lsa, rsa); err != nil {
			fd.Close()
			return nil, err
		}
		fd.isConnected = true
		if !deadline.IsZero() {
			setWriteDeadline(fd, noDeadline)
		}
	}

	lsa, _ = syscall.Getsockname(s)
	if rsa, _ = syscall.Getpeername(s); rsa != nil {
		fd.setAddr(toAddr(lsa), toAddr(rsa))
	} else {
		fd.setAddr(toAddr(lsa), raddr)
	}
	return fd, nil
}