Documentation
¶
Index ¶
- func Filter(addrs []ma.Multiaddr) []ma.Multiaddr
- type AutoRelay
- type AutoRelayHost
- type ClockWithInstantTimer
- type InstantTimer
- type Option
- func WithBackoff(d time.Duration) Option
- func WithBootDelay(d time.Duration) Option
- func WithClock(cl ClockWithInstantTimer) Option
- func WithMaxCandidateAge(d time.Duration) Option
- func WithMaxCandidates(n int) Option
- func WithMinCandidates(n int) Option
- func WithMinInterval(interval time.Duration) Option
- func WithNumRelays(n int) Option
- func WithPeerSource(f PeerSource) Option
- func WithStaticRelays(static []peer.AddrInfo) Option
- type PeerSource
- type RealClock
- type RealTimer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AutoRelayHost ¶
func NewAutoRelayHost ¶
func NewAutoRelayHost(h host.Host, ar *AutoRelay) *AutoRelayHost
func (*AutoRelayHost) Close ¶
func (h *AutoRelayHost) Close() error
func (*AutoRelayHost) Start ¶
func (h *AutoRelayHost) Start()
type ClockWithInstantTimer ¶
type ClockWithInstantTimer interface {
Now() time.Time
Since(t time.Time) time.Duration
InstantTimer(when time.Time) InstantTimer
}
ClockWithInstantTimer is a clock that can create timers that trigger at some instant rather than some duration
type InstantTimer ¶
InstantTimer is a timer that triggers at some instant rather than some duration
type Option ¶
type Option func(*config) error
func WithBackoff ¶
WithBackoff sets the time we wait after failing to obtain a reservation with a candidate.
func WithBootDelay ¶
WithBootDelay set the boot delay for finding relays. We won't attempt any reservation if we've have less than a minimum number of candidates. This prevents us to connect to the "first best" relay, and allows us to carefully select the relay. However, in case we haven't found enough relays after the boot delay, we use what we have.
func WithClock ¶
func WithClock(cl ClockWithInstantTimer) Option
func WithMaxCandidateAge ¶
WithMaxCandidateAge sets the maximum age of a candidate. When we are connected to the desired number of relays, we don't ask the peer source for new candidates. This can lead to AutoRelay's candidate list becoming outdated, and means we won't be able to quickly establish a new relay connection if our existing connection breaks, if all the candidates have become stale.
func WithMaxCandidates ¶
WithMaxCandidates sets the number of relay candidates that we buffer.
func WithMinCandidates ¶
WithMinCandidates sets the minimum number of relay candidates we collect before to get a reservation with any of them (unless we've been running for longer than the boot delay). This is to make sure that we don't just randomly connect to the first candidate that we discover.
func WithMinInterval ¶
WithMinInterval sets the minimum interval after which peerSource callback will be called for more candidates even if AutoRelay needs new candidates.
func WithNumRelays ¶
WithNumRelays sets the number of relays we strive to obtain reservations with.
func WithPeerSource ¶
func WithPeerSource(f PeerSource) Option
WithPeerSource defines a callback for AutoRelay to query for more relay candidates.
func WithStaticRelays ¶
type PeerSource ¶
AutoRelay will call this function when it needs new candidates because it is not connected to the desired number of relays or we get disconnected from one of the relays. Implementations must send *at most* numPeers, and close the channel when they don't intend to provide any more peers. AutoRelay will not call the callback again until the channel is closed. Implementations should send new peers, but may send peers they sent before. AutoRelay implements a per-peer backoff (see WithBackoff). See WithMinInterval for setting the minimum interval between calls to the callback. The context.Context passed may be canceled when AutoRelay feels satisfied, it will be canceled when the node is shutting down. If the context is canceled you MUST close the output channel at some point.
type RealClock ¶
type RealClock struct{}
func (RealClock) InstantTimer ¶
func (RealClock) InstantTimer(when time.Time) InstantTimer
Source Files