package discovery

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

Dependency Relation
	imports 3 packages, and imported by 2 packages

Involved Source Files

	  d discovery.go
		Package discovery provides service advertisement and peer discovery interfaces for libp2p.

	    options.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type Advertiser (interface)
		Advertiser is an interface for advertising services

		Methods (only one)
			( Advertiser) Advertise(ctx context.Context, ns string, opts ...Option) (time.Duration, error)
				Advertise advertises a service

		Implemented By (at least 2)
			 Discovery (interface)
			*github.com/libp2p/go-libp2p/p2p/discovery/backoff.BackoffDiscovery

	 type Discoverer (interface)
		Discoverer is an interface for peer discovery

		Methods (only one)
			( Discoverer) FindPeers(ctx context.Context, ns string, opts ...Option) (<-chan peer.AddrInfo, error)
				FindPeers discovers peers providing a service

		Implemented By (at least 2)
			 Discovery (interface)
			*github.com/libp2p/go-libp2p/p2p/discovery/backoff.BackoffDiscovery

	 type Discovery (interface)
		Discovery is an interface that combines service advertisement and peer discovery

		Methods (total 2)
			( Discovery) Advertise(ctx context.Context, ns string, opts ...Option) (time.Duration, error)
				Advertise advertises a service

			( Discovery) FindPeers(ctx context.Context, ns string, opts ...Option) (<-chan peer.AddrInfo, error)
				FindPeers discovers peers providing a service

		Implemented By (at least one exported)
			*github.com/libp2p/go-libp2p/p2p/discovery/backoff.BackoffDiscovery
		Implements (at least 2)
			 Discovery : Advertiser
			 Discovery : Discoverer
		As Outputs Of (at least one exported)
			func github.com/libp2p/go-libp2p/p2p/discovery/backoff.NewBackoffDiscovery(disc Discovery, stratFactory backoff.BackoffFactory, opts ...backoff.BackoffDiscoveryOption) (Discovery, error)
		As Inputs Of (at least 2)
			func github.com/libp2p/go-libp2p/p2p/discovery/backoff.NewBackoffDiscovery(disc Discovery, stratFactory backoff.BackoffFactory, opts ...backoff.BackoffDiscoveryOption) (Discovery, error)
			func github.com/libp2p/go-libp2p-pubsub.WithDiscovery(d Discovery, opts ...pubsub.DiscoverOpt) pubsub.Option

	 type Option (func)
		DiscoveryOpt is a single discovery option.

		As Outputs Of (at least 2)
			func Limit(limit int) Option
			func TTL(ttl time.Duration) Option
		As Inputs Of (at least 8)
			func Advertiser.Advertise(ctx context.Context, ns string, opts ...Option) (time.Duration, error)
			func Discoverer.FindPeers(ctx context.Context, ns string, opts ...Option) (<-chan peer.AddrInfo, error)
			func Discovery.Advertise(ctx context.Context, ns string, opts ...Option) (time.Duration, error)
			func Discovery.FindPeers(ctx context.Context, ns string, opts ...Option) (<-chan peer.AddrInfo, error)
			func (*Options).Apply(options ...Option) error
			func github.com/libp2p/go-libp2p/p2p/discovery/backoff.(*BackoffDiscovery).Advertise(ctx context.Context, ns string, opts ...Option) (time.Duration, error)
			func github.com/libp2p/go-libp2p/p2p/discovery/backoff.(*BackoffDiscovery).FindPeers(ctx context.Context, ns string, opts ...Option) (<-chan peer.AddrInfo, error)
			func github.com/libp2p/go-libp2p-pubsub.WithDiscoveryOpts(opts ...Option) pubsub.DiscoverOpt

	 type Options (struct)
		DiscoveryOpts is a set of discovery options.

		Fields (total 3)
			Limit int
			Other map[interface{}]interface{}
				Other (implementation-specific) options

			Ttl time.Duration
		Methods (only one)
			(*Options) Apply(options ...Option) error
				Apply applies the given options to this DiscoveryOpts



Package-Level Functions (total 2)

	 func Limit(limit int) Option
		Limit is an option that provides an upper bound on the peer count for discovery

	 func TTL(ttl time.Duration) Option
		TTL is an option that provides a hint for the duration of an advertisement

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.