package libp2p

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

Dependency Relation
	imports 43 packages, and imported by one package

Involved Source Files

	    defaults.go
	    libp2p.go
	    limits.go
	    options.go
	    options_filter.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Config = config.Config (struct)
		Config describes a set of settings for a libp2p node.

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


Package-Level Functions (total 47)

	 func AddrsFactory(factory config.AddrsFactory) Option
		AddrsFactory configures libp2p to use the given address factory.

	 func AutoNATServiceRateLimit(global, perPeer int, interval time.Duration) Option
		AutoNATServiceRateLimit changes the default rate limiting configured in helping
		other peers determine their reachability status. When set, the host will limit
		the number of requests it responds to in each 60 second period to the set
		numbers. A value of '0' disables throttling.

	 func BandwidthReporter(rep metrics.Reporter) Option
		BandwidthReporter configures libp2p to use the given bandwidth reporter.

	 func ChainOptions(opts ...Option) Option
		ChainOptions chains multiple options into a single option.

	 func ConnectionGater(cg connmgr.ConnectionGater) Option
		ConnectionGater configures libp2p to use the given ConnectionGater
		to actively reject inbound/outbound connections based on the lifecycle stage
		of the connection.
		
		For more information, refer to go-libp2p/core.ConnectionGater.

	 func ConnectionManager(connman connmgr.ConnManager) Option
		ConnectionManager configures libp2p to use the given connection manager.
		
		The current "standard" connection manager lives in github.com/libp2p/go-libp2p-connmgr. See
		https://pkg.go.dev/github.com/libp2p/go-libp2p-connmgr?utm_source=godoc#NewConnManager.

	 func DialRanker(d network.DialRanker) Option
		DialRanker configures libp2p to use d as the dial ranker. To enable smart
		dialing use `swarm.DefaultDialRanker`. use `swarm.NoDelayDialRanker` to
		disable smart dialing.
		
		Deprecated: use SwarmOpts(swarm.WithDialRanker(d)) instead

	 func DisableIdentifyAddressDiscovery() Option
		DisableIdentifyAddressDiscovery disables address discovery using peer provided observed addresses
		in identify. If you know your public addresses upfront, the recommended way is to use
		AddressFactory to provide the external adddress to the host and use this option to disable
		discovery from identify.

	 func DisableMetrics() Option
		DisableMetrics configures libp2p to disable prometheus metrics

	 func DisableRelay() Option
		DisableRelay configures libp2p to disable the relay transport.

	 func EnableAutoNATv2() Option
		EnableAutoNATv2 enables autonat v2

	 func EnableAutoRelay(opts ...autorelay.Option) Option
		EnableAutoRelay configures libp2p to enable the AutoRelay subsystem.
		
		Dependencies:
		  - Relay (enabled by default)
		  - Either:
		    1. A list of static relays
		    2. A PeerSource function that provides a chan of relays. See `autorelay.WithPeerSource`
		
		This subsystem performs automatic address rewriting to advertise relay addresses when it
		detects that the node is publicly unreachable (e.g. behind a NAT).
		
		Deprecated: Use EnableAutoRelayWithStaticRelays or EnableAutoRelayWithPeerSource

	 func EnableAutoRelayWithPeerSource(peerSource autorelay.PeerSource, opts ...autorelay.Option) Option
		EnableAutoRelayWithPeerSource configures libp2p to enable the AutoRelay
		subsystem using the provided PeerSource callback to get more relay
		candidates.  This subsystem performs automatic address rewriting to advertise
		relay addresses when it detects that the node is publicly unreachable (e.g.
		behind a NAT).

	 func EnableAutoRelayWithStaticRelays(static []peer.AddrInfo, opts ...autorelay.Option) Option
		EnableAutoRelayWithStaticRelays configures libp2p to enable the AutoRelay subsystem using
		the provided relays as relay candidates.
		This subsystem performs automatic address rewriting to advertise relay addresses when it
		detects that the node is publicly unreachable (e.g. behind a NAT).

	 func EnableHolePunching(opts ...holepunch.Option) Option
		Experimental
		EnableHolePunching enables NAT traversal by enabling NATT'd peers to both initiate and respond to hole punching attempts
		to create direct/NAT-traversed connections with other peers. (default: disabled)
		
		Dependencies:
		  - Relay (enabled by default)
		
		This subsystem performs two functions:
		
		 1. On receiving an inbound Relay connection, it attempts to create a direct connection with the remote peer
		    by initiating and co-ordinating a hole punch over the Relayed connection.
		 2. If a peer sees a request to co-ordinate a hole punch on an outbound Relay connection,
		    it will participate in the hole-punch to create a direct connection with the remote peer.
		
		If the hole punch is successful, all new streams will thereafter be created on the hole-punched connection.
		The Relayed connection will eventually be closed after a grace period.
		
		All existing indefinite long-lived streams on the Relayed connection will have to re-opened on the hole-punched connection by the user.
		Users can make use of the `Connected`/`Disconnected` notifications emitted by the Network for this purpose.
		
		It is not mandatory but nice to also enable the `AutoRelay` option (See `EnableAutoRelay`)
		so the peer can discover and connect to Relay servers  if it discovers that it is NATT'd and has private reachability via AutoNAT.
		This will then enable it to advertise Relay addresses which can be used to accept inbound Relay connections to then co-ordinate
		a hole punch.
		
		If `EnableAutoRelay` is configured and the user is confident that the peer has private reachability/is NATT'd,
		the `ForceReachabilityPrivate` option can be configured to short-circuit reachability discovery via AutoNAT
		so the peer can immediately start connecting to Relay servers.
		
		If `EnableAutoRelay` is configured, the `StaticRelays` option can be used to configure a static set of Relay servers
		for `AutoRelay` to connect to so that it does not need to discover Relay servers via Routing.

	 func EnableNATService() Option
		EnableNATService configures libp2p to provide a service to peers for determining
		their reachability status. When enabled, the host will attempt to dial back
		to peers, and then tell them if it was successful in making such connections.

	 func EnableRelay() Option
		EnableRelay configures libp2p to enable the relay transport.
		This option only configures libp2p to accept inbound connections from relays
		and make outbound connections_through_ relays when requested by the remote peer.
		This option supports both circuit v1 and v2 connections.
		(default: enabled)

	 func EnableRelayService(opts ...relayv2.Option) Option
		EnableRelayService configures libp2p to run a circuit v2 relay,
		if we detect that we're publicly reachable.

	 func ForceReachabilityPrivate() Option
		ForceReachabilityPrivate overrides automatic reachability detection in the AutoNAT subsystem,
		forceing the local node to believe it is behind a NAT and not reachable externally.

	 func ForceReachabilityPublic() Option
		ForceReachabilityPublic overrides automatic reachability detection in the AutoNAT subsystem,
		forcing the local node to believe it is reachable externally.

	 func Identity(sk crypto.PrivKey) Option
		Identity configures libp2p to use the given private key to identify itself.

	 func IPv6BlackHoleSuccessCounter(f *swarm.BlackHoleSuccessCounter) Option
		IPv6BlackHoleSuccessCounter configures libp2p to use f as the black hole filter for IPv6 addrs

	 func ListenAddrs(addrs ...ma.Multiaddr) Option
		ListenAddrs configures libp2p to listen on the given addresses.

	 func ListenAddrStrings(s ...string) Option
		ListenAddrStrings configures libp2p to listen on the given (unparsed)
		addresses.

	 func MultiaddrResolver(rslv network.MultiaddrDNSResolver) Option
		MultiaddrResolver sets the libp2p dns resolver

	 func Muxer(name string, muxer network.Multiplexer) Option
		Muxer configures libp2p to use the given stream multiplexer.
		name is the protocol name.

	 func NATManager(nm config.NATManagerC) Option
		NATManager will configure libp2p to use the requested NATManager. This
		function should be passed a NATManager *constructor* that takes a libp2p Network.

	 func NATPortMap() Option
		NATPortMap configures libp2p to use the default NATManager. The default
		NATManager will attempt to open a port in your network's firewall using UPnP.

	 func New(opts ...Option) (host.Host, error)
		New constructs a new libp2p node with the given options, falling back on
		reasonable defaults. The defaults are:
		
		- If no transport and listen addresses are provided, the node listens to
		the multiaddresses "/ip4/0.0.0.0/tcp/0" and "/ip6/::/tcp/0";
		
		- If no transport options are provided, the node uses TCP, websocket and QUIC
		transport protocols;
		
		- If no multiplexer configuration is provided, the node is configured by
		default to use yamux;
		
		- If no security transport is provided, the host uses the go-libp2p's noise
		and/or tls encrypted transport to encrypt all traffic;
		
		- If no peer identity is provided, it generates a random Ed25519 key-pair
		and derives a new identity from it;
		
		- If no peerstore is provided, the host is initialized with an empty
		peerstore.
		
		To stop/shutdown the returned libp2p node, the user needs to call `Close` on the returned Host.

	 func NewWithoutDefaults(opts ...Option) (host.Host, error)
		NewWithoutDefaults constructs a new libp2p node with the given options but
		*without* falling back on reasonable defaults.
		
		Warning: This function should not be considered a stable interface. We may
		choose to add required services at any time and, by using this function, you
		opt-out of any defaults we may provide.

	 func Peerstore(ps peerstore.Peerstore) Option
		Peerstore configures libp2p to use the given peerstore.

	 func Ping(enable bool) Option
		Ping will configure libp2p to support the ping service; enable by default.

	 func PrivateNetwork(psk pnet.PSK) Option
		PrivateNetwork configures libp2p to use the given private network protector.

	 func PrometheusRegisterer(reg prometheus.Registerer) Option
		PrometheusRegisterer configures libp2p to use reg as the Registerer for all metrics subsystems

	 func ProtocolVersion(s string) Option
		ProtocolVersion sets the protocolVersion string required by the
		libp2p Identify protocol.

	 func QUICReuse(constructor interface{}, opts ...quicreuse.Option) Option
	 func ResourceManager(rcmgr network.ResourceManager) Option
		ResourceManager configures libp2p to use the given ResourceManager.
		When using the p2p/host/resource-manager implementation of the ResourceManager interface,
		it is recommended to set limits for libp2p protocol by calling SetDefaultServiceLimits.

	 func Routing(rt config.RoutingC) Option
		Routing will configure libp2p to use routing.

	 func Security(name string, constructor interface{}) Option
		Security configures libp2p to use the given security transport (or transport
		constructor).
		
		Name is the protocol name.
		
		The transport can be a constructed security.Transport or a function taking
		any subset of this libp2p node's:
		* Public key
		* Private key
		* Peer ID
		* Host
		* Network
		* Peerstore

	 func SetDefaultServiceLimits(config *rcmgr.ScalingLimitConfig)
		SetDefaultServiceLimits sets the default limits for bundled libp2p services

	 func ShareTCPListener() Option
		ShareTCPListener shares the same listen address between TCP and Websocket
		transports. This lets both transports use the same TCP port.
		
		Currently this behavior is Opt-in. In a future release this will be the
		default, and this option will be removed.

	 func SwarmOpts(opts ...swarm.Option) Option
		SwarmOpts configures libp2p to use swarm with opts

	 func Transport(constructor interface{}, opts ...interface{}) Option
		Transport configures libp2p to use the given transport (or transport
		constructor).
		
		The transport can be a constructed transport.Transport or a function taking
		any subset of this libp2p node's:
		* Transport Upgrader (*tptu.Upgrader)
		* Host
		* Stream muxer (muxer.Transport)
		* Security transport (security.Transport)
		* Private network protector (pnet.Protector)
		* Peer ID
		* Private Key
		* Public Key
		* Address filter (filter.Filter)
		* Peerstore

	 func UDPBlackHoleSuccessCounter(f *swarm.BlackHoleSuccessCounter) Option
		UDPBlackHoleSuccessCounter configures libp2p to use f as the black hole filter for UDP addrs

	 func UserAgent(userAgent string) Option
		UserAgent sets the libp2p user-agent sent along with the identify protocol

	 func WithDialTimeout(t time.Duration) Option
	 func WithFxOption(opts ...fx.Option) Option
		WithFxOption adds a user provided fx.Option to the libp2p constructor.
		Experimental: This option is subject to change or removal.


Package-Level Variables (total 16)

	  var DefaultConnectionManager func(cfg *Config) error
		DefaultConnectionManager creates a default connection manager

	  var DefaultEnableRelay func(cfg *Config) error
		DefaultEnableRelay enables relay dialing and listening by default.

	  var DefaultListenAddrs func(cfg *Config) error
		DefaultListenAddrs configures libp2p to use default listen address.

	  var DefaultMuxers Option
		DefaultMuxers configures libp2p to use the stream connection multiplexers.
		
		Use this option when you want to *extend* the set of multiplexers used by
		libp2p instead of replacing them.

	  var DefaultPeerstore Option
		DefaultPeerstore configures libp2p to use the default peerstore.

	  var DefaultPrivateTransports Option
		DefaultPrivateTransports are the default libp2p transports when a PSK is supplied.
		
		Use this option when you want to *extend* the set of transports used by
		libp2p instead of replacing them.

	  var DefaultPrometheusRegisterer func(cfg *Config) error
		DefaultPrometheusRegisterer configures libp2p to use the default registerer

	  var DefaultResourceManager func(cfg *Config) error
	  var Defaults Option
		Defaults configures libp2p to use the default options. Can be combined with
		other options to *extend* the default options.

	  var DefaultSecurity Option
		DefaultSecurity is the default security option.
		
		Useful when you want to extend, but not replace, the supported transport
		security protocols.

	  var DefaultTransports Option
		DefaultTransports are the default libp2p transports.
		
		Use this option when you want to *extend* the set of transports used by
		libp2p instead of replacing them.

	  var FallbackDefaults Option
		FallbackDefaults applies default options to the libp2p node if and only if no
		other relevant options have been applied. will be appended to the options
		passed into New.

	  var NoListenAddrs func(cfg *Config) error
		NoListenAddrs will configure libp2p to not listen by default.
		
		This will both clear any configured listen addrs and prevent libp2p from
		applying the default listen address option. It also disables relay, unless the
		user explicitly specifies with an option, as the transport creates an implicit
		listen address that would make the node dialable through any relay it was connected to.

	  var NoSecurity Option
		NoSecurity is an option that completely disables all transport security.
		It's incompatible with all other transport security protocols.

	  var NoTransports func(cfg *Config) error
		NoTransports will configure libp2p to not enable any transports.
		
		This will both clear any configured transports (specified in prior libp2p
		options) and prevent libp2p from applying the default transports.

	  var RandomIdentity func(cfg *Config) error
		RandomIdentity generates a random identity. (default behaviour)

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.