refactor globals

convert.go

@@ -13,10 +13,14 @@ var errIncorrectNetAddr = fmt.Errorf("incorrect network addr conversion")
 
 // FromNetAddr converts a net.Addr type to a Multiaddr.
 func FromNetAddr(a net.Addr) (ma.Multiaddr, error) {
+	return defaultCodecs.FromNetAddr(a)
+}
+
+func (cm *CodecMap) FromNetAddr(a net.Addr) (ma.Multiaddr, error) {
 	if a == nil {
 		return nil, fmt.Errorf("nil multiaddr")
 	}
-	p, err := getAddrParser(a.Network())
+	p, err := cm.getAddrParser(a.Network())
 	if err != nil {
 		return nil, err
 	}
@@ -28,10 +32,14 @@ func FromNetAddr(a net.Addr) (ma.Multiaddr, error) {
 // Must be ThinWaist. acceptable protocol stacks are:
 // /ip{4,6}/{tcp, udp}
 func ToNetAddr(maddr ma.Multiaddr) (net.Addr, error) {
+	return defaultCodecs.ToNetAddr(maddr)
+}
+
+func (cm *CodecMap) ToNetAddr(maddr ma.Multiaddr) (net.Addr, error) {
 	protos := maddr.Protocols()
 	final := protos[len(protos)-1]
 
-	p, err := getMaddrParser(final.Name)
+	p, err := cm.getMaddrParser(final.Name)
 	if err != nil {
 		return nil, err
 	}
@@ -73,6 +81,8 @@ func FromIP(ip net.IP) (ma.Multiaddr, error) {
 
 // DialArgs is a convenience function returning arguments for use in net.Dial
 func DialArgs(m ma.Multiaddr) (string, string, error) {
+	// TODO: find a 'good' way to eliminate the function.
+	// My preference is with a multiaddr.Format(...) function
 	if !IsThinWaist(m) {
 		return "", "", fmt.Errorf("%s is not a 'thin waist' address", m)
 	}

registry.go

@@ -8,104 +8,118 @@ import (
 	ma "github.com/jbenet/go-multiaddr"
 )
 
-type AddrParser func(a net.Addr) (ma.Multiaddr, error)
+type FromNetAddrFunc func(a net.Addr) (ma.Multiaddr, error)
-type MaddrParser func(ma ma.Multiaddr) (net.Addr, error)
+type ToNetAddrFunc func(ma ma.Multiaddr) (net.Addr, error)
 
-var maddrParsers map[string]MaddrParser
+var defaultCodecs *CodecMap
-var addrParsers map[string]AddrParser
-var addrParsersLock sync.Mutex
 
-type AddressSpec struct {
+func init() {
-	// NetNames is an array of strings that may be returned
+	defaultCodecs = NewCodecMap()
+	defaultCodecs.RegisterNetCodec(tcpAddrSpec)
+	defaultCodecs.RegisterNetCodec(udpAddrSpec)
+	defaultCodecs.RegisterNetCodec(utpAddrSpec)
+	defaultCodecs.RegisterNetCodec(ip4AddrSpec)
+	defaultCodecs.RegisterNetCodec(ip6AddrSpec)
+}
+
+type CodecMap struct {
+	codecs       map[string]*NetCodec
+	addrParsers  map[string]FromNetAddrFunc
+	maddrParsers map[string]ToNetAddrFunc
+	lk           sync.Mutex
+}
+
+func NewCodecMap() *CodecMap {
+	return &CodecMap{
+		codecs:       make(map[string]*NetCodec),
+		addrParsers:  make(map[string]FromNetAddrFunc),
+		maddrParsers: make(map[string]ToNetAddrFunc),
+	}
+}
+
+type NetCodec struct {
+	// NetAddrNetworks is an array of strings that may be returned
 	// by net.Addr.Network() calls on addresses belonging to this type
-	NetNames []string
+	NetAddrNetworks []string
 
-	// Key is the string value for Multiaddr address keys
+	// ProtocolName is the string value for Multiaddr address keys
-	Key string
+	ProtocolName string
 
 	// ParseNetAddr parses a net.Addr belonging to this type into a multiaddr
-	ParseNetAddr AddrParser
+	ParseNetAddr FromNetAddrFunc
 
 	// ConvertMultiaddr converts a multiaddr of this type back into a net.Addr
-	ConvertMultiaddr MaddrParser
+	ConvertMultiaddr ToNetAddrFunc
 
 	// Protocol returns the multiaddr protocol struct for this type
 	Protocol ma.Protocol
 }
 
-func RegisterAddressType(a *AddressSpec) {
+func RegisterNetCodec(a *NetCodec) {
-	addrParsersLock.Lock()
+	defaultCodecs.RegisterNetCodec(a)
-	defer addrParsersLock.Unlock()
+}
-	for _, n := range a.NetNames {
+
-		addrParsers[n] = a.ParseNetAddr
+func (cm *CodecMap) RegisterNetCodec(a *NetCodec) {
+	cm.lk.Lock()
+	defer cm.lk.Unlock()
+	cm.codecs[a.ProtocolName] = a
+	for _, n := range a.NetAddrNetworks {
+		cm.addrParsers[n] = a.ParseNetAddr
 	}
 
-	maddrParsers[a.Key] = a.ConvertMultiaddr
+	cm.maddrParsers[a.ProtocolName] = a.ConvertMultiaddr
 }
 
-func init() {
+var tcpAddrSpec = &NetCodec{
-	addrParsers = make(map[string]AddrParser)
+	ProtocolName:     "tcp",
-	maddrParsers = make(map[string]MaddrParser)
+	NetAddrNetworks:  []string{"tcp", "tcp4", "tcp6"},
-
-	RegisterAddressType(tcpAddrSpec)
-	RegisterAddressType(udpAddrSpec)
-	RegisterAddressType(utpAddrSpec)
-	RegisterAddressType(ip4AddrSpec)
-	RegisterAddressType(ip6AddrSpec)
-
-	addrParsers["ip+net"] = parseIpPlusNetAddr
-}
-
-var tcpAddrSpec = &AddressSpec{
-	Key:              "tcp",
-	NetNames:         []string{"tcp", "tcp4", "tcp6"},
 	ParseNetAddr:     parseTcpNetAddr,
 	ConvertMultiaddr: parseBasicNetMaddr,
 }
 
-var udpAddrSpec = &AddressSpec{
+var udpAddrSpec = &NetCodec{
-	Key:              "udp",
+	ProtocolName:     "udp",
-	NetNames:         []string{"udp", "udp4", "udp6"},
+	NetAddrNetworks:  []string{"udp", "udp4", "udp6"},
 	ParseNetAddr:     parseUdpNetAddr,
 	ConvertMultiaddr: parseBasicNetMaddr,
 }
 
-var utpAddrSpec = &AddressSpec{
+var utpAddrSpec = &NetCodec{
-	Key:              "utp",
+	ProtocolName:     "utp",
-	NetNames:         []string{"utp", "utp4", "utp6"},
+	NetAddrNetworks:  []string{"utp", "utp4", "utp6"},
 	ParseNetAddr:     parseUtpNetAddr,
 	ConvertMultiaddr: parseBasicNetMaddr,
 }
 
-var ip4AddrSpec = &AddressSpec{
+var ip4AddrSpec = &NetCodec{
-	Key:              "ip4",
+	ProtocolName:     "ip4",
-	NetNames:         []string{"ip4"},
+	NetAddrNetworks:  []string{"ip4"},
 	ParseNetAddr:     parseIpNetAddr,
 	ConvertMultiaddr: parseBasicNetMaddr,
 }
 
-var ip6AddrSpec = &AddressSpec{
+var ip6AddrSpec = &NetCodec{
-	Key:              "ip6",
+	ProtocolName:     "ip6",
-	NetNames:         []string{"ip6"},
+	NetAddrNetworks:  []string{"ip6"},
 	ParseNetAddr:     parseIpNetAddr,
 	ConvertMultiaddr: parseBasicNetMaddr,
 }
 
-func getAddrParser(net string) (AddrParser, error) {
+func (cm *CodecMap) getAddrParser(net string) (FromNetAddrFunc, error) {
-	addrParsersLock.Lock()
+	cm.lk.Lock()
-	defer addrParsersLock.Unlock()
+	defer cm.lk.Unlock()
 
-	parser, ok := addrParsers[net]
+	parser, ok := cm.addrParsers[net]
 	if !ok {
 		return nil, fmt.Errorf("unknown network %v", net)
 	}
 	return parser, nil
 }
 
-func getMaddrParser(name string) (MaddrParser, error) {
+func (cm *CodecMap) getMaddrParser(name string) (ToNetAddrFunc, error) {
-	addrParsersLock.Lock()
+	cm.lk.Lock()
-	defer addrParsersLock.Unlock()
+	defer cm.lk.Unlock()
-	p, ok := maddrParsers[name]
+	p, ok := cm.maddrParsers[name]
 	if !ok {
 		return nil, fmt.Errorf("network not supported: %s", name)
 	}

registry_test.go

@@ -8,43 +8,43 @@ import (
 )
 
 func TestRegisterSpec(t *testing.T) {
-	myproto := &AddressSpec{
+	cm := NewCodecMap()
-		Key:              "test",
+	myproto := &NetCodec{
-		NetNames:         []string{"test", "iptest", "blahtest"},
+		ProtocolName:     "test",
+		NetAddrNetworks:  []string{"test", "iptest", "blahtest"},
 		ConvertMultiaddr: func(a ma.Multiaddr) (net.Addr, error) { return nil, nil },
 		ParseNetAddr:     func(a net.Addr) (ma.Multiaddr, error) { return nil, nil },
 	}
 
-	RegisterAddressType(myproto)
+	cm.RegisterNetCodec(myproto)
 
-	_, ok := addrParsers["test"]
+	_, ok := cm.addrParsers["test"]
 	if !ok {
 		t.Fatal("myproto not properly registered")
 	}
 
-	_, ok = addrParsers["iptest"]
+	_, ok = cm.addrParsers["iptest"]
 	if !ok {
 		t.Fatal("myproto not properly registered")
 	}
 
-	_, ok = addrParsers["blahtest"]
+	_, ok = cm.addrParsers["blahtest"]
 	if !ok {
 		t.Fatal("myproto not properly registered")
 	}
 
-	_, ok = maddrParsers["test"]
+	_, ok = cm.maddrParsers["test"]
 	if !ok {
 		t.Fatal("myproto not properly registered")
 	}
 
-	_, ok = maddrParsers["iptest"]
+	_, ok = cm.maddrParsers["iptest"]
 	if ok {
 		t.Fatal("myproto not properly registered")
 	}
 
-	_, ok = maddrParsers["blahtest"]
+	_, ok = cm.maddrParsers["blahtest"]
 	if ok {
 		t.Fatal("myproto not properly registered")
 	}
-
 }