README
¶
go-multiaddr-net
Multiaddress net tools
This package provides Multiaddr specific versions of common functions in stdlib's net package. This means wrappers of standard net symbols like net.Dial and net.Listen, as well
as conversion to and from net.Addr.
Table of Contents
Install
go-multiaddr-net is a standard Go module which can be installed with:
go get github.com/multiformats/go-multiaddr-net
Note that go-multiaddr-net is packaged with Gx, so it is recommended to use Gx to install and use it (see Usage section).
Usage
This module is packaged with Gx. In order to use it in your own project do:
go get -u github.com/whyrusleeping/gx
go get -u github.com/whyrusleeping/gx-go
cd <your-project-repository>
gx init
gx import github.com/multiformats/go-multiaddr-net
gx install --global
gx-go --rewrite
Please check Gx and Gx-go documentation for more information.
For further usage, see the docs:
multiaddr/net: https://godoc.org/github.com/multiformats/go-multiaddr-netmultiaddr: https://godoc.org/github.com/multiformats/go-multiaddr
Maintainers
Captain: @whyrusleeping.
Contribute
Contributions welcome. Please check out the issues.
Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.
Small note: If editing the README, please conform to the standard-readme specification.
License
MIT © 2014 Juan Batiz-Benet
Documentation
¶
Overview ¶
Package manet provides Multiaddr specific versions of common functions in stdlib's net package. This means wrappers of standard net symbols like net.Dial and net.Listen, as well as conversion to/from net.Addr.
Package manet provides Multiaddr (https://github.com/multiformats/go-multiaddr) specific versions of common functions in Go's standard `net` package. This means wrappers of standard net symbols like `net.Dial` and `net.Listen`, as well as conversion to and from `net.Addr`.
Index ¶
- Variables
- func AddrMatch(match ma.Multiaddr, addrs []ma.Multiaddr) []ma.Multiaddr
- func DialArgs(m ma.Multiaddr) (string, string, error)
- func FromIP(ip net.IP) (ma.Multiaddr, error)
- func FromNetAddr(a net.Addr) (ma.Multiaddr, error)
- func InterfaceMultiaddrs() ([]ma.Multiaddr, error)
- func IsIP6LinkLocal(m ma.Multiaddr) bool
- func IsIPLoopback(m ma.Multiaddr) bool
- func IsIPUnspecified(m ma.Multiaddr) bool
- func IsThinWaist(m ma.Multiaddr) bool
- func NetListener(l Listener) net.Listener
- func RegisterNetCodec(a *NetCodec)
- func ToNetAddr(maddr ma.Multiaddr) (net.Addr, error)
- type CodecMap
- type Conn
- type Dialer
- type FromNetAddrFunc
- type Listener
- type NetCodec
- type PacketConn
- type ToNetAddrFunc
Constants ¶
This section is empty.
Variables ¶
var ( // IP4Loopback is the ip4 loopback multiaddr IP4Loopback = ma.StringCast("/ip4/127.0.0.1") // IP6Loopback is the ip6 loopback multiaddr IP6Loopback = ma.StringCast("/ip6/::1") // IP6LinkLocalLoopback is the ip6 link-local loopback multiaddr IP6LinkLocalLoopback = ma.StringCast("/ip6/fe80::1") )
Loopback Addresses
var ( IP4Unspecified = ma.StringCast("/ip4/0.0.0.0") IP6Unspecified = ma.StringCast("/ip6/::") )
Unspecified Addresses (used for )
Functions ¶
func FromNetAddr ¶
FromNetAddr converts a net.Addr type to a Multiaddr.
func InterfaceMultiaddrs ¶
InterfaceMultiaddrs will return the addresses matching net.InterfaceAddrs
func IsIP6LinkLocal ¶
IsIP6LinkLocal returns if a multiaddress is an IPv6 local link. These addresses are non routable. The prefix is technically fe80::/10, but we test fe80::/16 for simplicity (no need to mask). So far, no hardware interfaces exist long enough to use those 2 bits. Send a PR if there is.
func IsIPLoopback ¶
IsIPLoopback returns whether a Multiaddr is a "Loopback" IP address This means either /ip4/127.*.*.*, /ip6/::1, or /ip6/fe80::1
func IsIPUnspecified ¶
IsIPUnspecified returns whether a Multiaddr is am Unspecified IP address This means either /ip4/0.0.0.0 or /ip6/::
func IsThinWaist ¶
IsThinWaist returns whether a Multiaddr starts with "Thin Waist" Protocols. This means: /{IP4, IP6}[/{TCP, UDP}]
func NetListener ¶ added in v1.6.0
NetListener turns this Listener into a net.Listener.
- Connections returned from Accept implement multiaddr-net Conn.
- Calling WrapNetListener on the net.Listener returned by this function will return the original (underlying) multiaddr-net Listener.
func RegisterNetCodec ¶ added in v1.1.0
func RegisterNetCodec(a *NetCodec)
RegisterNetCodec adds a new NetCodec to the default codecs.
Types ¶
type CodecMap ¶ added in v1.1.0
type CodecMap struct {
// contains filtered or unexported fields
}
CodecMap holds a map of NetCodecs indexed by their Protocol ID along with parsers for the addresses they use. It is used to keep a list of supported network address codecs (protocols which addresses can be converted to and from multiaddresses).
func NewCodecMap ¶ added in v1.1.0
func NewCodecMap() *CodecMap
NewCodecMap initializes and returns a CodecMap object.
func (*CodecMap) FromNetAddr ¶ added in v1.1.0
FromNetAddr converts a net.Addr to Multiaddress.
func (*CodecMap) RegisterNetCodec ¶ added in v1.1.0
RegisterNetCodec adds a new NetCodec to the CodecMap. This function is thread safe.
type Conn ¶
type Conn interface {
net.Conn
// LocalMultiaddr returns the local Multiaddr associated
// with this connection
LocalMultiaddr() ma.Multiaddr
// RemoteMultiaddr returns the remote Multiaddr associated
// with this connection
RemoteMultiaddr() ma.Multiaddr
}
Conn is the equivalent of a net.Conn object. It is the result of calling the Dial or Listen functions in this package, with associated local and remote Multiaddrs.
func Dial ¶
Dial connects to a remote address. It uses an underlying net.Conn, then wraps it in a Conn object (with local and remote Multiaddrs).
func WrapNetConn ¶
WrapNetConn wraps a net.Conn object with a Multiaddr friendly Conn.
This function does it's best to avoid "hiding" methods exposed by the wrapped type. Guarantees:
- If the wrapped connection exposes the "half-open" closer methods (CloseWrite, CloseRead), these will be available on the wrapped connection via type assertions.
- If the wrapped connection is a UnixConn, IPConn, TCPConn, or UDPConn, all methods on these wrapped connections will be available via type assertions.
type Dialer ¶
type Dialer struct {
// Dialer is just an embedded net.Dialer, with all its options.
net.Dialer
// LocalAddr is the local address to use when dialing an
// address. The address must be of a compatible type for the
// network being dialed.
// If nil, a local address is automatically chosen.
LocalAddr ma.Multiaddr
}
Dialer contains options for connecting to an address. It is effectively the same as net.Dialer, but its LocalAddr and RemoteAddr options are Multiaddrs, instead of net.Addrs.
type FromNetAddrFunc ¶ added in v1.1.0
FromNetAddrFunc is a generic function which converts a net.Addr to Multiaddress
type Listener ¶
type Listener interface {
// Accept waits for and returns the next connection to the listener.
// Returns a Multiaddr friendly Conn
Accept() (Conn, error)
// Close closes the listener.
// Any blocked Accept operations will be unblocked and return errors.
Close() error
// Multiaddr returns the listener's (local) Multiaddr.
Multiaddr() ma.Multiaddr
// Addr returns the net.Listener's network address.
Addr() net.Addr
}
A Listener is a generic network listener for stream-oriented protocols. it uses an embedded net.Listener, overriding net.Listener.Accept to return a Conn and providing Multiaddr.
type NetCodec ¶ added in v1.1.0
type NetCodec struct {
// NetAddrNetworks is an array of strings that may be returned
// by net.Addr.Network() calls on addresses belonging to this type
NetAddrNetworks []string
// ProtocolName is the string value for Multiaddr address keys
ProtocolName string
// ParseNetAddr parses a net.Addr belonging to this type into a multiaddr
ParseNetAddr FromNetAddrFunc
// ConvertMultiaddr converts a multiaddr of this type back into a net.Addr
ConvertMultiaddr ToNetAddrFunc
// Protocol returns the multiaddr protocol struct for this type
Protocol ma.Protocol
}
NetCodec is used to identify a network codec, that is, a network type for which we are able to translate multiaddresses into standard Go net.Addr and back.
type PacketConn ¶ added in v1.5.6
type PacketConn interface {
Connection() net.PacketConn
Multiaddr() ma.Multiaddr
ReadFrom(b []byte) (int, ma.Multiaddr, error)
WriteTo(b []byte, maddr ma.Multiaddr) (int, error)
Close() error
}
A PacketConn is a generic packet oriented network connection which uses an underlying net.PacketConn, wrapped with the locally bound Multiaddr.
func ListenPacket ¶ added in v1.5.6
func ListenPacket(laddr ma.Multiaddr) (PacketConn, error)
ListenPacket announces on the local network address laddr. The Multiaddr must be a packet driven network, like udp4 or udp6. See Dial for the syntax of laddr.
func WrapPacketConn ¶ added in v1.5.6
func WrapPacketConn(pc net.PacketConn) (PacketConn, error)
WrapPacketConn wraps a net.PacketConn with a manet.PacketConn.
Source Files
Directories