config

Documentation

Index

• Constants
• func Filename(configroot string) (string, error)
• func Marshal(value interface{}) ([]byte, error)
• func ToMap(conf *Config) (map[string]interface{}, error)
• type Addresses
• type Config
  • func ConfigInit(nbits int) (*Config, error)
  • func FromMap(v map[string]interface{}) (*Config, error)
• type ConnMgr
• type Identity

Constants

const (
	// DefaultConfigFile is the filename of the configuration file
	DefaultConfigFile = "config"

	SwarmPort = "3700"
)

Functions

func Filename

func Filename(configroot string) (string, error)

Filename returns the configuration file path given a configuration root directory. If the configuration root directory is empty, use the default one

func Marshal

func Marshal(value interface{}) ([]byte, error)

Marshal configuration with JSON

func ToMap

func ToMap(conf *Config) (map[string]interface{}, error)

Types

type Addresses

type Addresses struct {
	Swarm []string // addresses for the swarm to listen on
}

Addresses stores the (string) multiaddr addresses for the node.

type Config

type Config struct {
	Identity   Identity  // local node's peer identity
	Addresses  Addresses // local node's addresses
	Bootstrap  []string
	DeviceName string
	ConnMgr    ConnMgr
	// ReprovideInterval sets how often to reprovide records to the DHT
	ReprovideInterval time.Duration
}

Config wraps configuration options for the Peer.

func ConfigInit

func ConfigInit(nbits int) (*Config, error)

func FromMap

func FromMap(v map[string]interface{}) (*Config, error)

type ConnMgr

type ConnMgr struct {
	LowWater  int
	HighWater int
}

type Identity

type Identity struct {
	PeerID  string
	PrivKey string `json:",omitempty"`
}

Identity tracks the configuration of the local node's identity.