package config

Import Path
	github.com/libp2p/go-libp2p/config (on go.dev)

Dependency Relation
	imports 51 packages, and imported by one package


Involved Source Files

	    config.go
	    host.go
	    log.go
	    quic.go


Package-Level Type Names (total 7)


	/* sort by:  |  */
	
		AddrsFactory is a function that takes a set of multiaddrs we're listening on and
		returns the set of multiaddrs we should advertise to the network.


	
		AutoNATConfig defines the AutoNAT behavior for the libp2p host.

		
			EnableService bool
			ForceReachability *network.Reachability
			ThrottleGlobalLimit int
			ThrottleInterval time.Duration
			ThrottlePeerLimit int


	
		Config describes a set of settings for a libp2p node
		
		This is *not* a stable interface. Use the options defined in the root
		package.

		
			AddrsFactory bhost.AddrsFactory
			AutoNATConfig AutoNATConfig
			AutoNATConfig.EnableService bool
			AutoNATConfig.ForceReachability *network.Reachability
			AutoNATConfig.ThrottleGlobalLimit int
			AutoNATConfig.ThrottleInterval time.Duration
			AutoNATConfig.ThrottlePeerLimit int
			AutoRelayOpts []autorelay.Option
			ConnManager connmgr.ConnManager
			ConnectionGater connmgr.ConnectionGater
			CustomIPv6BlackHoleSuccessCounter bool
			CustomUDPBlackHoleSuccessCounter bool
			DialRanker network.DialRanker
			DialTimeout time.Duration
			DisableIdentifyAddressDiscovery bool
			DisableMetrics bool
			DisablePing bool
			EnableAutoNATv2 bool
			EnableAutoRelay bool
			EnableHolePunching bool
			
				// should we run a circuitv2 relay (if publicly reachable)

			HolePunchingOptions []holepunch.Option
			IPv6BlackHoleSuccessCounter *swarm.BlackHoleSuccessCounter
			Insecure bool
			ListenAddrs []ma.Multiaddr
			MultiaddrResolver network.MultiaddrDNSResolver
			Muxers []tptu.StreamMuxer
			NATManager NATManagerC
			PSK pnet.PSK
			PeerKey crypto.PrivKey
			Peerstore peerstore.Peerstore
			PrometheusRegisterer prometheus.Registerer
			
				ProtocolVersion is the protocol version that identifies the family
				of protocols used by the peer in the Identify protocol. It is set
				using the [ProtocolVersion] option.

			QUICReuse []fx.Option
			
				// should the relay transport be used

			RelayCustom bool
			RelayServiceOpts []relayv2.Option
			Reporter metrics.Reporter
			ResourceManager network.ResourceManager
			Routing RoutingC
			SecurityTransports []Security
			ShareTCPListener bool
			SwarmOpts []swarm.Option
			Transports []fx.Option
			UDPBlackHoleSuccessCounter *swarm.BlackHoleSuccessCounter
			
				UserAgent is the identifier this node will send to other peers when
				identifying itself, e.g. via the identify protocol.
				
				Set it via the UserAgent option function.

			UserFxOptions []fx.Option
		
			
				Apply applies the given options to the config, returning the first error
				encountered (if any).

			
				NewNode constructs a new libp2p Host from the Config.
				
				This function consumes the config. Do not reuse it (really!).



	
		NATManagerC is a NATManager constructor.

		
			func github.com/libp2p/go-libp2p.NATManager(nm NATManagerC) libp2p.Option


	
		Option is a libp2p config option that can be given to the libp2p constructor
		(`libp2p.New`).

		
			func (*Config).Apply(opts ...Option) error
		
			  var github.com/libp2p/go-libp2p.DefaultMuxers
			  var github.com/libp2p/go-libp2p.DefaultPeerstore
			  var github.com/libp2p/go-libp2p.DefaultPrivateTransports
			  var github.com/libp2p/go-libp2p.Defaults
			  var github.com/libp2p/go-libp2p.DefaultSecurity
			  var github.com/libp2p/go-libp2p.DefaultTransports
			  var github.com/libp2p/go-libp2p.FallbackDefaults
			  var github.com/libp2p/go-libp2p.NoSecurity


	

		
			func github.com/libp2p/go-libp2p.Routing(rt RoutingC) libp2p.Option


	

		
			Constructor interface{}
			ID protocol.ID