conf

Documentation

Index

• Constants
• Variables
• func BindAddrIsSet() bool
• func Client() bool
• func EnableClient(enable bool)
• func EnablePublicHub(enable bool)
• func GetBindAddr(dialNetwork string) net.Addr
• func GetBindIPs() []net.IP
• func HubHasIPv4() bool
• func HubHasIPv6() bool
• func PublicHub() bool
• func SetBindAddr(ip4, ip6 net.IP)
• func SetHubNetworks(v4, v6 bool)

Constants

const (
	// VersionOne is the first protocol version.
	VersionOne = 1

	// CurrentVersion always holds the newest version in production.
	CurrentVersion = 1
)

Variables

var (
	MainMapName  = "main"
	MainMapScope = hub.ScopePublic
)

Primary Map Configuration.

Functions

func BindAddrIsSet

func BindAddrIsSet() bool

BindAddrIsSet returns whether any bind address is set.

func Client

func Client() bool

Client returns whether this is a client.

func EnableClient

func EnableClient(enable bool)

EnableClient enables the client mode.

func EnablePublicHub

func EnablePublicHub(enable bool)

EnablePublicHub enables the public hub mode.

func GetBindAddr

func GetBindAddr(dialNetwork string) net.Addr

GetBindAddr returns an address with the preferred binding address for the given dial network. The dial network must have a suffix specifying the IP version.

func GetBindIPs

func GetBindIPs() []net.IP

GetBindIPs returns the preferred binding IPs. Returns a slice with a single nil IP if no preferred binding IPs are set.

func HubHasIPv4

func HubHasIPv4() bool

HubHasIPv4 returns whether the Hub has IPv4 support.

func HubHasIPv6

func HubHasIPv6() bool

HubHasIPv6 returns whether the Hub has IPv6 support.

func PublicHub

func PublicHub() bool

PublicHub returns whether this is a public Hub.

func SetBindAddr

func SetBindAddr(ip4, ip6 net.IP)

SetBindAddr sets the preferred connect (bind) addresses.

func SetHubNetworks

func SetHubNetworks(v4, v6 bool)

SetHubNetworks sets the available IP networks on the Hub.