Documentation
      ¶
    
    
  
    
  
    Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AddrsFactory ¶
type AddrsFactory = bhost.AddrsFactory
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.
type AutoNATConfig ¶
type AutoNATConfig struct {
	ForceReachability   *network.Reachability
	EnableService       bool
	ThrottleGlobalLimit int
	ThrottlePeerLimit   int
	ThrottleInterval    time.Duration
}
    AutoNATConfig defines the AutoNAT behavior for the libp2p host.
type Config ¶
type Config struct {
	// 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.
	UserAgent string
	// 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.
	ProtocolVersion string
	PeerKey crypto.PrivKey
	QUICReuse          []fx.Option
	Transports         []fx.Option
	Muxers             []tptu.StreamMuxer
	SecurityTransports []Security
	Insecure           bool
	PSK                pnet.PSK
	DialTimeout time.Duration
	RelayCustom bool
	Relay       bool // should the relay transport be used
	EnableRelayService bool // should we run a circuitv2 relay (if publicly reachable)
	RelayServiceOpts   []relayv2.Option
	ListenAddrs     []ma.Multiaddr
	AddrsFactory    bhost.AddrsFactory
	ConnectionGater connmgr.ConnectionGater
	ConnManager     connmgr.ConnManager
	ResourceManager network.ResourceManager
	NATManager NATManagerC
	Peerstore  peerstore.Peerstore
	Reporter   metrics.Reporter
	MultiaddrResolver *madns.Resolver
	DisablePing bool
	Routing RoutingC
	EnableAutoRelay bool
	AutoRelayOpts   []autorelay.Option
	AutoNATConfig
	EnableHolePunching  bool
	HolePunchingOptions []holepunch.Option
	DisableMetrics       bool
	PrometheusRegisterer prometheus.Registerer
	DialRanker network.DialRanker
	SwarmOpts []swarm.Option
}
    Config describes a set of settings for a libp2p node
This is *not* a stable interface. Use the options defined in the root package.
type NATManagerC ¶
type NATManagerC func(network.Network) bhost.NATManager
NATManagerC is a NATManager constructor.
 Click to show internal directories. 
   Click to hide internal directories.