decision

Documentation

Overview

package decision implements the decision engine for the bitswap service.

Index

• Variables
• type Engine
  • func NewEngine(ctx context.Context, bs bstore.Blockstore) *Engine
  • func (e *Engine) AddBlock(block blocks.Block)
  • func (e *Engine) LedgerForPeer(p peer.ID) *Receipt
  • func (e *Engine) MessageReceived(p peer.ID, m bsmsg.BitSwapMessage) error
  • func (e *Engine) MessageSent(p peer.ID, m bsmsg.BitSwapMessage) error
  • func (e *Engine) Outbox() <-chan (<-chan *Envelope)
  • func (e *Engine) PeerConnected(p peer.ID)
  • func (e *Engine) PeerDisconnected(p peer.ID)
  • func (e *Engine) Peers() []peer.ID
  • func (e *Engine) WantlistForPeer(p peer.ID) (out []*wl.Entry)
• type Envelope
• type Receipt

Variables

var FIFO = func(a, b *peerRequestTask) bool {
	return a.created.Before(b.created)
}

FIFO is a basic task comparator that returns tasks in the order created.

var V1 = func(a, b *peerRequestTask) bool {
	if a.Target == b.Target {
		return a.Priority > b.Priority
	}
	return FIFO(a, b)
}

V1 respects the target peer's wantlist priority. For tasks involving different peers, the oldest task is prioritized.

Types

type Engine

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

func NewEngine

func NewEngine(ctx context.Context, bs bstore.Blockstore) *Engine

func (*Engine) AddBlock

func (e *Engine) AddBlock(block blocks.Block)

func (*Engine) LedgerForPeer

func (e *Engine) LedgerForPeer(p peer.ID) *Receipt

func (*Engine) MessageReceived

func (e *Engine) MessageReceived(p peer.ID, m bsmsg.BitSwapMessage) error

MessageReceived performs book-keeping. Returns error if passed invalid arguments.

func (*Engine) MessageSent

func (e *Engine) MessageSent(p peer.ID, m bsmsg.BitSwapMessage) error

func (*Engine) Outbox

func (e *Engine) Outbox() <-chan (<-chan *Envelope)

Outbox returns a channel of one-time use Envelope channels.

func (*Engine) PeerConnected

func (e *Engine) PeerConnected(p peer.ID)

func (*Engine) PeerDisconnected

func (e *Engine) PeerDisconnected(p peer.ID)

func (*Engine) Peers

func (e *Engine) Peers() []peer.ID

Returns a slice of Peers with whom the local node has active sessions

func (*Engine) WantlistForPeer

func (e *Engine) WantlistForPeer(p peer.ID) (out []*wl.Entry)

type Envelope

type Envelope struct {
	// Peer is the intended recipient
	Peer peer.ID

	// Message is the payload
	Message bsmsg.BitSwapMessage

	// A callback to notify the decision queue that the task is complete
	Sent func()
}

Envelope contains a message for a Peer

type Receipt

type Receipt struct {
	Peer      string
	Value     float64
	Sent      uint64
	Recv      uint64
	Exchanged uint64
}