blockservice

Documentation

Overview

package blockservice implements a BlockService interface that provides a single GetBlock/AddBlock interface that seamlessly retrieves data either locally or from a remote peer through the exchange.

Index

• Variables
• type BlockService
  • func New(bs blockstore.Blockstore, rem exchange.Interface) *BlockService
  • func (s *BlockService) AddBlock(b *blocks.Block) (key.Key, error)
  • func (s *BlockService) AddBlocks(bs []*blocks.Block) ([]key.Key, error)
  • func (s *BlockService) Close() error
  • func (s *BlockService) DeleteBlock(k key.Key) error
  • func (s *BlockService) GetBlock(ctx context.Context, k key.Key) (*blocks.Block, error)
  • func (s *BlockService) GetBlocks(ctx context.Context, ks []key.Key) <-chan *blocks.Block

Variables

var ErrNotFound = errors.New("blockservice: key not found")

Types

type BlockService

type BlockService struct {
	// TODO don't expose underlying impl details
	Blockstore blockstore.Blockstore
	Exchange   exchange.Interface
}

BlockService is a hybrid block datastore. It stores data in a local datastore and may retrieve data from a remote Exchange. It uses an internal `datastore.Datastore` instance to store values.

func New

func New(bs blockstore.Blockstore, rem exchange.Interface) *BlockService

NewBlockService creates a BlockService with given datastore instance.

func (*BlockService) AddBlock

func (s *BlockService) AddBlock(b *blocks.Block) (key.Key, error)

AddBlock adds a particular block to the service, Putting it into the datastore. TODO pass a context into this if the remote.HasBlock is going to remain here.

func (*BlockService) AddBlocks

func (s *BlockService) AddBlocks(bs []*blocks.Block) ([]key.Key, error)

func (*BlockService) Close

func (s *BlockService) Close() error

func (*BlockService) DeleteBlock

func (s *BlockService) DeleteBlock(k key.Key) error

DeleteBlock deletes a block in the blockservice from the datastore

func (*BlockService) GetBlock

func (s *BlockService) GetBlock(ctx context.Context, k key.Key) (*blocks.Block, error)

GetBlock retrieves a particular block from the service, Getting it from the datastore using the key (hash).

func (*BlockService) GetBlocks

func (s *BlockService) GetBlocks(ctx context.Context, ks []key.Key) <-chan *blocks.Block

GetBlocks gets a list of blocks asynchronously and returns through the returned channel. NB: No guarantees are made about order.