network

Documentation

Index

• func IsLocalAddress(src LocalAddressSource, addr AddressGroup) bool
• func StringifyGroup(x AddressGroup) string
• func VerifyMultiAddress(ni *netmap.NodeInfo) error
• func WriteToNodeInfo(g AddressGroup, ni *netmap.NodeInfo)
• type Address
  • func (a *Address) FromString(s string) error
  • func (a Address) HostAddr() string
  • func (a Address) String() string
  • func (a Address) TLSEnabled() bool
• type AddressGroup
  • func (x *AddressGroup) FromIterator(iter MultiAddressIterator) error
  • func (x AddressGroup) Intersects(x2 AddressGroup) bool
  • func (x AddressGroup) IterateAddresses(f func(Address) bool)
  • func (x AddressGroup) Len() int
  • func (x AddressGroup) Less(i, j int) bool
  • func (x AddressGroup) Swap(i, j int)
• type LocalAddressSource
• type MultiAddressIterator

Functions

func IsLocalAddress

func IsLocalAddress(src LocalAddressSource, addr AddressGroup) bool

IsLocalAddress returns true if network endpoints from local address group source intersects with network endpoints of passed address group.

func StringifyGroup

func StringifyGroup(x AddressGroup) string

StringifyGroup returns concatenation of all addresses from the AddressGroup.

The result is order-dependent.

func VerifyMultiAddress

func VerifyMultiAddress(ni *netmap.NodeInfo) error

VerifyMultiAddress validates multiaddress of n.

If n's address contains more than 3 protocols or less than 2 protocols an error returns.

If n's address's protocol order is incorrect an error returns.

Correct composition(and order from low to high level) of protocols:

1. dns4/ip4/ip6
2. tcp
3. tls(optional, may be absent)

func WriteToNodeInfo

func WriteToNodeInfo(g AddressGroup, ni *netmap.NodeInfo)

WriteToNodeInfo writes AddressGroup to netmap.NodeInfo structure.

Types

type Address

type Address struct {
	// contains filtered or unexported fields
}

Address represents the NeoFS node network address.

func (*Address) FromString

func (a *Address) FromString(s string) error

FromString restores Address from a string representation.

Supports URIAddr, MultiAddr and HostAddr strings.

func (Address) HostAddr

func (a Address) HostAddr() string

HostAddr returns host address in string format.

Panics if host address cannot be fetched from Address.

func (Address) String

func (a Address) String() string

String returns multiaddr string.

func (Address) TLSEnabled

func (a Address) TLSEnabled() bool

TLSEnabled searches for wrapped TLS protocol in multiaddr.

type AddressGroup

type AddressGroup []Address

AddressGroup represents list of network addresses of the node.

List is sorted by priority of use.

func (*AddressGroup) FromIterator

func (x *AddressGroup) FromIterator(iter MultiAddressIterator) error

FromIterator forms AddressGroup from MultiAddressIterator structure. The result is sorted with sort.Sort.

Returns an error in the absence of addresses or if any of the addresses are incorrect.

func (AddressGroup) Intersects

func (x AddressGroup) Intersects(x2 AddressGroup) bool

Intersects checks if two AddressGroup have at least one common address.

func (AddressGroup) IterateAddresses

func (x AddressGroup) IterateAddresses(f func(Address) bool)

IterateAddresses iterates over all network addresses of the node.

Breaks iterating on handler's true return.

Handler should not be nil.

func (AddressGroup) Len

func (x AddressGroup) Len() int

Len returns number of addresses in AddressGroup.

func (AddressGroup) Less

func (x AddressGroup) Less(i, j int) bool

Less returns true if i-th address in AddressGroup supports TLS and j-th one doesn't.

func (AddressGroup) Swap

func (x AddressGroup) Swap(i, j int)

Swap swaps i-th and j-th addresses in AddressGroup.

type LocalAddressSource

type LocalAddressSource interface {
	LocalAddress() AddressGroup
}

LocalAddressSource is an interface of local network address container with read access.

type MultiAddressIterator

type MultiAddressIterator interface {
	// Must iterate over network addresses and pass each one
	// to the handler until it returns true.
	IterateAddresses(func(string) bool)

	// Must return number of addresses in group.
	NumberOfAddresses() int
}

MultiAddressIterator is an interface of network address group.