README
¶
go-libp2p-discovery
Interfaces for active peer discovery
This package contains interfaces and utilities for active peer discovery. Peers providing a service use the interface to advertise their presence in some namespace. Vice versa, peers seeking a service use the interface to discover peers that have previously advertised as service providers. The package also includes a baseline implementation for discovery through Content Routing.
Documenation
See https://godoc.org/github.com/libp2p/go-libp2p-discovery.
Contribute
Feel free to join in. All welcome. Open an issue!
This repository falls under the IPFS Code of Conduct.
License
MIT
The last gx published version of this module was: 1.0.15: QmWA8k8apx6egshEjemkuxpKNJS7W7heCgzTnBhAvX9yoB
Documentation
¶
Index ¶
- func Advertise(ctx context.Context, a Advertiser, ns string, opts ...Option)
- func FindPeers(ctx context.Context, d Discoverer, ns string, opts ...Option) ([]peer.AddrInfo, error)
- func FullJitter(duration, min, max time.Duration, rng *rand.Rand) time.Duration
- func Limit(limit int) core.Optiondeprecated
- func NewBackoffDiscovery(disc discovery.Discovery, stratFactory BackoffFactory, ...) (discovery.Discovery, error)
- func NoJitter(duration, min, max time.Duration, rng *rand.Rand) time.Duration
- func TTL(ttl time.Duration) core.Optiondeprecated
- type Advertiserdeprecated
- type BackoffConnector
- type BackoffDiscovery
- type BackoffDiscoveryOption
- type BackoffFactory
- func NewExponentialBackoff(min, max time.Duration, jitter Jitter, timeUnits time.Duration, base float64, ...) BackoffFactory
- func NewExponentialDecorrelatedJitter(min, max time.Duration, base float64, rngSrc rand.Source) BackoffFactory
- func NewFixedBackoff(delay time.Duration) BackoffFactory
- func NewPolynomialBackoff(min, max time.Duration, jitter Jitter, timeUnits time.Duration, ...) BackoffFactory
- type BackoffStrategy
- type Discovererdeprecated
- type Discoverydeprecated
- type DiscoveryRouting
- type Jitter
- type Optiondeprecated
- type Optionsdeprecated
- type RoutingDiscovery
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Advertise ¶
func Advertise(ctx context.Context, a Advertiser, ns string, opts ...Option)
Advertise is a utility function that persistently advertises a service through an Advertiser.
func FindPeers ¶
func FindPeers(ctx context.Context, d Discoverer, ns string, opts ...Option) ([]peer.AddrInfo, error)
FindPeers is a utility function that synchronously collects peers from a Discoverer.
func FullJitter ¶
FullJitter returns a random number uniformly chose from the range [min, boundedDur]. boundedDur is the duration bounded between min and max.
func NewBackoffDiscovery ¶
func NewBackoffDiscovery(disc discovery.Discovery, stratFactory BackoffFactory, opts ...BackoffDiscoveryOption) (discovery.Discovery, error)
Types ¶
type Advertiser
deprecated
type Advertiser = core.Advertiser
Deprecated: use skel.Advertiser instead.
type BackoffConnector ¶
type BackoffConnector struct {
// contains filtered or unexported fields
}
BackoffConnector is a utility to connect to peers, but only if we have not recently tried connecting to them already
func NewBackoffConnector ¶
func NewBackoffConnector(h host.Host, cacheSize int, connectionTryDuration time.Duration, backoff BackoffFactory) (*BackoffConnector, error)
NewBackoffConnector creates a utility to connect to peers, but only if we have not recently tried connecting to them already cacheSize is the size of a TwoQueueCache connectionTryDuration is how long we attempt to connect to a peer before giving up backoff describes the strategy used to decide how long to backoff after previously attempting to connect to a peer
func (*BackoffConnector) Connect ¶
func (c *BackoffConnector) Connect(ctx context.Context, peerCh <-chan peer.AddrInfo)
Connect attempts to connect to the peers passed in by peerCh. Will not connect to peers if they are within the backoff period. As Connect will attempt to dial peers as soon as it learns about them, the caller should try to keep the number, and rate, of inbound peers manageable.
type BackoffDiscovery ¶
type BackoffDiscovery struct {
// contains filtered or unexported fields
}
BackoffDiscovery is an implementation of discovery that caches peer data and attenuates repeated queries
type BackoffDiscoveryOption ¶
type BackoffDiscoveryOption func(*BackoffDiscovery) error
func WithBackoffDiscoveryReturnedChannelSize ¶
func WithBackoffDiscoveryReturnedChannelSize(size int) BackoffDiscoveryOption
WithBackoffDiscoveryReturnedChannelSize sets the size of the buffer to be used during a FindPeer query. Note: This does not apply if the query occurs during the backoff time
func WithBackoffDiscoverySimultaneousQueryBufferSize ¶
func WithBackoffDiscoverySimultaneousQueryBufferSize(size int) BackoffDiscoveryOption
WithBackoffDiscoverySimultaneousQueryBufferSize sets the buffer size for the channels between the main FindPeers query for a given namespace and all simultaneous FindPeers queries for the namespace
type BackoffFactory ¶
type BackoffFactory func() BackoffStrategy
func NewExponentialBackoff ¶
func NewExponentialBackoff(min, max time.Duration, jitter Jitter, timeUnits time.Duration, base float64, offset time.Duration, rngSrc rand.Source) BackoffFactory
NewExponentialBackoff creates a BackoffFactory with backoff of the form base^x + offset where x is the attempt number jitter is the function for adding randomness around the backoff timeUnits are the units of time the base^x is evaluated in
func NewExponentialDecorrelatedJitter ¶
func NewExponentialDecorrelatedJitter(min, max time.Duration, base float64, rngSrc rand.Source) BackoffFactory
NewExponentialDecorrelatedJitter creates a BackoffFactory with backoff of the roughly of the form base^x where x is the attempt number. Delays start at the minimum duration and after each attempt delay = rand(min, delay * base), bounded by the max See https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/ for more information
func NewFixedBackoff ¶
func NewFixedBackoff(delay time.Duration) BackoffFactory
NewFixedBackoff creates a BackoffFactory with a constant backoff duration
func NewPolynomialBackoff ¶
func NewPolynomialBackoff(min, max time.Duration, jitter Jitter, timeUnits time.Duration, polyCoefs []float64, rngSrc rand.Source) BackoffFactory
NewPolynomialBackoff creates a BackoffFactory with backoff of the form c0*x^0, c1*x^1, ...cn*x^n where x is the attempt number jitter is the function for adding randomness around the backoff timeUnits are the units of time the polynomial is evaluated in polyCoefs is the array of polynomial coefficients from [c0, c1, ... cn]
type BackoffStrategy ¶
type BackoffStrategy interface {
// Delay calculates how long the next backoff duration should be, given the prior calls to Delay
Delay() time.Duration
// Reset clears the internal state of the BackoffStrategy
Reset()
}
BackoffStrategy describes how backoff will be implemented. BackoffStratgies are stateful.
type Discoverer
deprecated
type Discoverer = core.Discoverer
Deprecated: use skel.Discoverer instead.
type DiscoveryRouting ¶
func NewDiscoveryRouting ¶
func NewDiscoveryRouting(disc discovery.Discovery, opts ...discovery.Option) *DiscoveryRouting
func (*DiscoveryRouting) FindProvidersAsync ¶
type Jitter ¶
Jitter must return a duration between min and max. Min must be lower than, or equal to, max.
type RoutingDiscovery ¶
type RoutingDiscovery struct {
routing.ContentRouting
}
RoutingDiscovery is an implementation of discovery using ContentRouting. Namespaces are translated to Cids using the SHA256 hash.
func NewRoutingDiscovery ¶
func NewRoutingDiscovery(router routing.ContentRouting) *RoutingDiscovery
Source Files