book

Documentation

Index

• type Address
• type Book
  • func New(opts ...Opt) *Book
  • func (b *Book) Add(src, id ID, raw Address)
  • func (b *Book) DrainQueue(n int) []Address
  • func (b *Book) Persist(w io.Writer) error
  • func (b *Book) Recover(r io.Reader) error
  • func (b *Book) Stats() Stats
  • func (b *Book) TakeShareable(src ID, n int) []Address
  • func (b *Book) Update(id ID, events ...Event)
• type Event
• type ID
• type Opt
  • func WithLimit(limit int) Opt
  • func WithRand(seed int64) Opt
• type Stats

Types

type Address

type Address = ma.Multiaddr

type Book

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

func New

func New(opts ...Opt) *Book

func (*Book) Add

func (b *Book) Add(src, id ID, raw Address)

func (*Book) DrainQueue

func (b *Book) DrainQueue(n int) []Address

func (*Book) Persist

func (b *Book) Persist(w io.Writer) error

func (*Book) Recover

func (b *Book) Recover(r io.Reader) error

func (*Book) Stats

func (b *Book) Stats() Stats

func (*Book) TakeShareable

func (b *Book) TakeShareable(src ID, n int) []Address

func (*Book) Update

func (b *Book) Update(id ID, events ...Event)

type Event

type Event int

const (
	Protect Event = iota
	Connected
	Disconnected
	Success
	Fail
)

type ID

type ID = string

const SELF ID = "SELF"

type Opt

type Opt func(*Book)

func WithLimit

func WithLimit(limit int) Opt

WithLimit updates default book limit.

func WithRand

func WithRand(seed int64) Opt

WithRand overwrites default seed for determinism in tests.

type Stats

type Stats struct {
	Total     int
	Connected int

	Public  int
	Private int

	Stale   int
	Learned int
	Stable  int
}