-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
unresolved_addr.go
122 lines (108 loc) · 4.03 KB
/
unresolved_addr.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
// Copyright 2015 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
package util
import (
"fmt"
"net"
"os"
addrutil "github.com/cockroachdb/cockroach/pkg/util/netutil/addr"
)
// TestAddr is an address to use for test servers. Listening on port 0
// causes the kernel to allocate an unused port.
var TestAddr = NewUnresolvedAddr("tcp", "127.0.0.1:0")
// IsolatedTestAddr is initialized in testaddr_*.go
// IsolatedTestAddr is an address to use for tests that need extra
// isolation by using more addresses than 127.0.0.1 (support for this
// is platform-specific and only enabled on Linux). Both TestAddr and
// IsolatedTestAddr guarantee that the chosen port is not in use when
// allocated, but IsolatedTestAddr draws from a larger pool of
// addresses so that when tests are run in a tight loop the system is
// less likely to run out of available ports or give a port to one
// test immediately after it was closed by another.
//
// IsolatedTestAddr should be used for tests that open and close a
// large number of sockets, or tests which stop a server and rely on
// seeing a "connection refused" error afterwards. It cannot be used
// with tests that operate in secure mode since our test certificates
// are only valid for 127.0.0.1.
var IsolatedTestAddr *UnresolvedAddr
// MakeUnresolvedAddr populates an UnresolvedAddr from a network and raw
// address string.
func MakeUnresolvedAddr(network, addr string) UnresolvedAddr {
return UnresolvedAddr{
NetworkField: network,
AddressField: addr,
}
}
// NewUnresolvedAddr creates a new UnresolvedAddr from a network and raw
// address string.
func NewUnresolvedAddr(network, addr string) *UnresolvedAddr {
return &UnresolvedAddr{
NetworkField: network,
AddressField: addr,
}
}
// MakeUnresolvedAddrWithDefaults creates a new UnresolvedAddr from a network and
// raw address string, using the following defaults if not given:
//
// - Network: tcp
// - Host: local hostname or 127.0.0.1
// - Port: given default port
func MakeUnresolvedAddrWithDefaults(network, addr, defaultPort string) UnresolvedAddr {
if network == "" {
network = "tcp"
}
if host, port, err := addrutil.SplitHostPort(addr, defaultPort); err != nil {
addr = net.JoinHostPort(addr, defaultPort)
} else {
if host == "" {
host, err = os.Hostname()
if err != nil {
host = "127.0.0.1"
}
}
addr = net.JoinHostPort(host, port)
}
return UnresolvedAddr{
NetworkField: network,
AddressField: addr,
}
}
// Note that we make *UnresolvedAddr implement the net.Addr interface, not
// UnresolvedAddr. This is done because assigning a non-empty struct to an
// interface requires an allocation, while assigning a pointer to an interface
// is allocation free. Using an *UnresolvedAddr makes it both clear that an
// allocation is occurring and allows us to avoid an allocation when an
// UnresolvedAddr is a field of a struct (e.g. NodeDescriptor.Address).
var _ net.Addr = &UnresolvedAddr{}
// Network returns the address's network name.
func (a *UnresolvedAddr) Network() string {
return a.NetworkField
}
// IsEmpty returns true if the address has no network or address specified.
func (a UnresolvedAddr) IsEmpty() bool {
return a == (UnresolvedAddr{})
}
// String returns the address's string form.
func (a UnresolvedAddr) String() string {
return a.AddressField
}
// Resolve attempts to resolve a into a net.Addr.
func (a UnresolvedAddr) Resolve() (net.Addr, error) {
switch a.NetworkField {
case "tcp", "tcp4", "tcp6":
return net.ResolveTCPAddr(a.NetworkField, a.AddressField)
case "udp", "udp4", "udp6":
return net.ResolveUDPAddr(a.NetworkField, a.AddressField)
case "unix", "unixgram", "unixpacket":
return net.ResolveUnixAddr(a.NetworkField, a.AddressField)
}
return nil, fmt.Errorf("network %s not supported", a.NetworkField)
}