bapl

README

Batch Pool

This package holds API of the BatchPool.

MemPool

MemPool implements BatchPool solely in memory.

MulticastPool

MulticastPool implements multicast pool that directly multicast batches to remote peers simultaneously.

Documentation

Overview

Package bapl implements rudimentary implementation of BatchPool

Index

• Variables
• type Batch
  • func (b *Batch) Hash() []byte
• type BatchPool
• type BatchVerifier
• type FetchIncludersFn
• type MemPool
  • func NewMemPool() *MemPool
  • func (p *MemPool) Close()
  • func (p *MemPool) Delete(_ context.Context, hash []byte) error
  • func (p *MemPool) ListBySigner(_ context.Context, key []byte) ([]*Batch, error)
  • func (p *MemPool) Pull(ctx context.Context, hash []byte) (*Batch, error)
  • func (p *MemPool) Push(_ context.Context, batch *Batch) error
  • func (p *MemPool) Size(context.Context) (int, error)
• type MulticastPool
  • func NewMulticastPool(pool BatchPool, host host.Host, includers FetchIncludersFn, ...) *MulticastPool
  • func (p *MulticastPool) Delete(ctx context.Context, hash []byte) error
  • func (p *MulticastPool) ListBySigner(ctx context.Context, bytes []byte) ([]*Batch, error)
  • func (p *MulticastPool) Pull(ctx context.Context, hash []byte) (*Batch, error)
  • func (p *MulticastPool) Push(ctx context.Context, batch *Batch) error
  • func (p *MulticastPool) Size(ctx context.Context) (int, error)
  • func (p *MulticastPool) Start()
  • func (p *MulticastPool) Stop()

Variables

var ErrBatchDeleted = errors.New("batch deleted")

Types

type Batch

type Batch struct {
	Data      []byte
	Signature crypto.Signature
}

func (*Batch) Hash

func (b *Batch) Hash() []byte

type BatchPool

type BatchPool interface {
	Push(context.Context, *Batch) error
	Pull(context.Context, []byte) (*Batch, error)
	ListBySigner(context.Context, []byte) ([]*Batch, error)
	Delete(context.Context, []byte) error
	Size(context.Context) (int, error)
}

type BatchVerifier

type BatchVerifier interface {
	Verify(context.Context, *Batch) (bool, error)
}

type FetchIncludersFn

type FetchIncludersFn func() []peer.ID

type MemPool

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

func NewMemPool

func NewMemPool() *MemPool

func (*MemPool) Close

func (p *MemPool) Close()

func (*MemPool) Delete

func (p *MemPool) Delete(_ context.Context, hash []byte) error

func (*MemPool) ListBySigner

func (p *MemPool) ListBySigner(_ context.Context, key []byte) ([]*Batch, error)

func (*MemPool) Pull

func (p *MemPool) Pull(ctx context.Context, hash []byte) (*Batch, error)

func (*MemPool) Push

func (p *MemPool) Push(_ context.Context, batch *Batch) error

func (*MemPool) Size

func (p *MemPool) Size(context.Context) (int, error)

type MulticastPool

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

func NewMulticastPool

func NewMulticastPool(
	pool BatchPool,
	host host.Host,
	includers FetchIncludersFn,
	signer crypto.Signer,
	verifier BatchVerifier,
) *MulticastPool

func (*MulticastPool) Delete

func (p *MulticastPool) Delete(ctx context.Context, hash []byte) error

func (*MulticastPool) ListBySigner

func (p *MulticastPool) ListBySigner(ctx context.Context, bytes []byte) ([]*Batch, error)

func (*MulticastPool) Pull

func (p *MulticastPool) Pull(ctx context.Context, hash []byte) (*Batch, error)

func (*MulticastPool) Push

func (p *MulticastPool) Push(ctx context.Context, batch *Batch) error

func (*MulticastPool) Size

func (p *MulticastPool) Size(ctx context.Context) (int, error)

func (*MulticastPool) Start

func (p *MulticastPool) Start()

func (*MulticastPool) Stop

func (p *MulticastPool) Stop()