mock

Documentation

Index

• type AddrTuple
• type Mock
  • func NewMockKademlia(o ...Option) *Mock
  • func (m *Mock) AddPeers(addr ...swarm.Address)
  • func (m *Mock) Close() error
  • func (m *Mock) ClosestPeer(addr swarm.Address, _ bool, skipPeers ...swarm.Address) (peerAddr swarm.Address, err error)
  • func (m *Mock) Connected(_ context.Context, addr swarm.Address) error
  • func (m *Mock) Disconnected(_ swarm.Address)
  • func (m *Mock) EachNeighbor(topology.EachPeerFunc) error
  • func (m *Mock) EachNeighborRev(topology.EachPeerFunc) error
  • func (m *Mock) EachPeer(f topology.EachPeerFunc) error
  • func (m *Mock) EachPeerRev(f topology.EachPeerFunc) error
  • func (d *Mock) Halt()
  • func (m *Mock) IsWithinDepth(adr swarm.Address) bool
  • func (m *Mock) NeighborhoodDepth() uint8
  • func (m *Mock) ResetPeers()
  • func (m *Mock) Snapshot() *topology.KadParams
  • func (m *Mock) SubscribePeersChange() (c <-chan struct{}, unsubscribe func())
  • func (m *Mock) Trigger()
• type Option
  • func WithDepth(d uint8) Option
  • func WithDepthCalls(d ...uint8) Option
  • func WithEachPeerRevCalls(addrs ...AddrTuple) Option

Types

type AddrTuple

type AddrTuple struct {
	Addr swarm.Address // the peer address
	PO   uint8         // the po
}

type Mock

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

func NewMockKademlia

func NewMockKademlia(o ...Option) *Mock

func (*Mock) AddPeers

func (m *Mock) AddPeers(addr ...swarm.Address)

AddPeers is called when a peers are added to the topology backlog for further processing by connectivity strategy.

func (*Mock) Close

func (m *Mock) Close() error

func (*Mock) ClosestPeer

func (m *Mock) ClosestPeer(addr swarm.Address, _ bool, skipPeers ...swarm.Address) (peerAddr swarm.Address, err error)

func (*Mock) Connected

func (m *Mock) Connected(_ context.Context, addr swarm.Address) error

Connected is called when a peer dials in.

func (*Mock) Disconnected

func (m *Mock) Disconnected(_ swarm.Address)

Disconnected is called when a peer disconnects.

func (*Mock) EachNeighbor

func (m *Mock) EachNeighbor(topology.EachPeerFunc) error

func (*Mock) EachNeighborRev

func (m *Mock) EachNeighborRev(topology.EachPeerFunc) error

func (*Mock) EachPeer

func (m *Mock) EachPeer(f topology.EachPeerFunc) error

EachPeer iterates from closest bin to farthest

func (*Mock) EachPeerRev

func (m *Mock) EachPeerRev(f topology.EachPeerFunc) error

EachPeerRev iterates from farthest bin to closest

func (*Mock) Halt

func (d *Mock) Halt()

func (*Mock) IsWithinDepth

func (m *Mock) IsWithinDepth(adr swarm.Address) bool

func (*Mock) NeighborhoodDepth

func (m *Mock) NeighborhoodDepth() uint8

func (*Mock) ResetPeers

func (m *Mock) ResetPeers()

func (*Mock) Snapshot

func (m *Mock) Snapshot() *topology.KadParams

func (*Mock) SubscribePeersChange

func (m *Mock) SubscribePeersChange() (c <-chan struct{}, unsubscribe func())

func (*Mock) Trigger

func (m *Mock) Trigger()

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithDepth

func WithDepth(d uint8) Option

func WithDepthCalls

func WithDepthCalls(d ...uint8) Option

func WithEachPeerRevCalls

func WithEachPeerRevCalls(addrs ...AddrTuple) Option