announcer

Documentation

Overview

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Announcer
  • func Default(client announceclient.Client, events Events, clk clock.Clock, ...) *Announcer
  • func New(config Config, client announceclient.Client, events Events, clk clock.Clock, ...) *Announcer
  • func (a *Announcer) Announce(d core.Digest, h core.InfoHash, complete bool) ([]*core.PeerInfo, error)
  • func (a *Announcer) Ticker(done <-chan struct{})
• type Config
• type Events

Types

type Announcer

type Announcer struct {
	// contains filtered or unexported fields
}

Announcer is a thin wrapper around an announceclient.Client which handles changes to the announce interval.

func Default

func Default(
	client announceclient.Client,
	events Events,
	clk clock.Clock,
	logger *zap.SugaredLogger) *Announcer

Default creates a default Announcer. TODO(evelynl94): make announce interval configurable.

func New

func New(
	config Config,
	client announceclient.Client,
	events Events,
	clk clock.Clock,
	logger *zap.SugaredLogger) *Announcer

New creates a new Announcer.

func (*Announcer) Announce

func (a *Announcer) Announce(
	d core.Digest, h core.InfoHash, complete bool) ([]*core.PeerInfo, error)

Announce announces through the underlying client and returns the resulting peer handout. Updates the announce interval if it has changed.

func (*Announcer) Ticker

func (a *Announcer) Ticker(done <-chan struct{})

Ticker emits AnnounceTick events at the current announce interval, which may be updated by Announce. Ticker exits when done is closed.

type Config

type Config struct {
	DefaultInterval time.Duration `yaml:"default_interval"`
	MaxInterval     time.Duration `yaml:"max_interval"`
}

Config defines Announcer configuration.

type Events

type Events interface {
	AnnounceTick()
}

Events defines Announcer events.