worker

Documentation

Overview

TODO FIXME name me

Index

• Variables
• type BlockList
  • func (s *BlockList) Len() int
  • func (s *BlockList) Pop() *blocks.Block
  • func (s *BlockList) Push(b *blocks.Block)
  • func (s *BlockList) PushFront(b *blocks.Block)
• type Config
• type Worker
  • func NewWorker(e exchange.Interface, c Config) *Worker
  • func (w *Worker) Close() error
  • func (w *Worker) HasBlock(b *blocks.Block) error

Variables

var DefaultConfig = Config{
	NumWorkers:       1,
	ClientBufferSize: 0,
	WorkerBufferSize: 0,
}

Types

type BlockList

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

func (*BlockList) Len

func (s *BlockList) Len() int

func (*BlockList) Pop

func (s *BlockList) Pop() *blocks.Block

func (*BlockList) Push

func (s *BlockList) Push(b *blocks.Block)

func (*BlockList) PushFront

func (s *BlockList) PushFront(b *blocks.Block)

type Config

type Config struct {
	// NumWorkers sets the number of background workers that provide blocks to
	// the exchange.
	NumWorkers int

	// ClientBufferSize allows clients of HasBlock to send up to
	// |ClientBufferSize| blocks without blocking.
	ClientBufferSize int

	// WorkerBufferSize can be used in conjunction with NumWorkers to reduce
	// communication-coordination within the worker.
	WorkerBufferSize int
}

type Worker

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

TODO FIXME name me

func NewWorker

func NewWorker(e exchange.Interface, c Config) *Worker

func (*Worker) Close

func (w *Worker) Close() error

func (*Worker) HasBlock

func (w *Worker) HasBlock(b *blocks.Block) error